[bcn-pm] Documentar Perl i persistència

[Xavier Noria]

On Jul 15, 2006, at 18:52, Marc Franquesa wrote:

> Primer salutacions en el meu 1er missatge a aquesta llista.
>
> Després  de fer bastants scripts senzills amb Perl, ara em trobo fent
> quelcom una mica més seriós i a més amb objectes (uf!). I la veritat
> és que perdo molt temps de desenvolupment redescobrint quines parts
> dels meus objectes són referències, referències a què, com es diuen
> els atributs, ....
>
> ¿Hi ha alguna eina per documentar els mòduls Perl tipus JavaDoc/ 
> Doxygen?
>
> M'he mirat el tema POD, però la veritat deixa molt que desitjar,
> senzillament és 'redactar' la documentació com si ho estiguessis fent
> amb un proc de textos. Jo em busco quelcom és automàtic.

POD es l'estandard, hom documenta amb POD i executa

   perldoc My/Module.pm

en una consola per veure la documentacio formatada. Si vols generacio  
d'HTML estatic un senzill script el pot generar cridant pod2html.

Si tens un sistema prou gran i orientat a objectes llavors podries  
usar OODoc. Aquesta es una eina que genera documentacio HTML i enten  
construccions d'OOP de Perl. No l'he usat mai pero en vaig veure una  
presentacio a una YAPC::Europe i te bona pinta:

   http://perl.overmeer.net/oodoc/

> La segona pregunta és demanar consell a algú que hagi experimentat més
> amb el tema que jo.
>
> Estic fent un mòdul per interpretar un XML i generar un objecte
> (compost de refs, arrays i hashes) a partir d'ell. La informació que
> se n'extrau ha de ser consultado moltes vegades, però el contingut de
> l'XML casi mai canviarà.

Coneixes XML::Simple?

-- fxn