[Rio-pm] Perl POD

Tiago Peczenyj tiago.peczenyj em gmail.com
Terça Dezembro 18 05:05:13 PST 2012


Eu tenho as minhas duvidas. Para pacotes sim é muito util pois cada função
que vc esta exportando ou cada método é importante de ser documentado pois
vai ser utilizado fora dali.

Agora se eu tenho um script ou uma aplicação eu gosto de colocar no final
para ter uma noção clara de todo o codigo.

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

> Obrigada, Stanislaw, Aureliano e Tiago!
>
> Vou estudar estes links que o Aureliano passou.
>
> Eu só usei até agora o POD depois do _END_ , mas vi que ele pode ser muito
> mais útil se eu usar desde o cabeçalho do script, poupando assim meus
> comentários tipo ### sobre cada função.
> Vou preparar uma apresentação sobre o uso do POD para meus colegas do
> laboratório. Se for implementado por todos, vai nos facilitar muito a vida.
>
> []'s
> Nicole
>
>
> PS: Não sei como não entrei no rio-pm antes... é tão bom!!!!
>
>
>   ------------------------------
> *De:* Nicole Scherer <bionica2007-perl em yahoo.com>
> *Para:* "rio-pm em pm.org" <rio-pm em pm.org>
> *Enviadas:* Terça-feira, 18 de Dezembro de 2012 10:27
> *Assunto:* [Rio-pm] Perl POD
>
> 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
>
>
> _______________________________________________
> 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/610c1a5e/attachment.html>


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