[Rio-pm] Perl POD

Tiago Peczenyj tiago.peczenyj em gmail.com
Terça Dezembro 18 04:43:22 PST 2012


Isso não é gambiarra se vc usar certo.

agora a vantagem do pod é a documentação estar no mesmo arquivo que o seu
módulo. assim vc não precisa editar dois ou mais arquivos para fazer uma
simples alteração e evita que a documentação fique obsoleta.

e fica pratico com o perldoc Seu::Modulo

agora vc pode ter .pod especificos para tutoriais ou outras explicações. a
vantagem do POD é ser built-in mas vc pode usar o que vc quiser pra
documentar, como um simples README em texto puro ou markdown, LaTeX,
postscript, pdf, word, etc. Tudo depende do que vc quer - timtowtdi.

2012/12/18 Nicole Scherer <bionica2007-perl em yahoo.com>

> Oi Mongers,
>
> vocês usam o perl POD para documentar seus scripts e pacotes, ou há outra
> estratégia de documentação mais recomendada.
>
> Pergunto, porque já usei (bem pouquinho) o POD, só que com ele eu perco a
> gambiarra de comentar pedaços grandes de código usando o =begin ... =cut.
> Existe outra estratégia não-gambiarra de comentar pedaços de código que
> não seja colocando # no início de cada linha?
>
> Acho engraçado que o próprio nome "Plain Old Documentation format" diz que
> é antigo (o que não necessariamente significa desatualizado)
> Li algo sobre "Natural Docs", alguém usa?
>
>
> []'s
> Nicole
>
> _______________________________________________
> Rio-pm mailing list
> Rio-pm em pm.org
> http://mail.pm.org/mailman/listinfo/rio-pm
>



-- 
Tiago B. Peczenyj
Linux User #405772

http://about.me/peczenyj
-------------- Próxima Parte ----------
Um anexo em HTML foi limpo...
URL: <http://mail.pm.org/pipermail/rio-pm/attachments/20121218/53eecb66/attachment-0001.html>


Mais detalhes sobre a lista de discussão Rio-pm