[Rio-pm] Perl POD

Andre Carneiro andregarciacarneiro em gmail.com
Terça Dezembro 18 05:13:10 PST 2012


Nicole


POD é a muito tempo o esquema de documentação 'oficial', principalmente se
você pensar em publicação(CPAN). É o que o CPAN aceita para publicações.
Mas, provavelmente, estou bem mal-informado sobre isso. Melhor dar uma
olhada, caso pretenda publicar algo no CPAN.

De qualquer forma, a muito tempo eu ouso falar no doxygen, embora nunca
tenha usado. Se não me engano, é o esquema que o pessoal de  PHP e Java se
baseam para documentar. É possível 'cuspir' documentação em Latex, e outros
formatos, assim como POD. A diferença é que eles tem APIs facilitadoras
prontas para indexar e 'cuspir' documentação em vários formatos. POD é meio
'faca na caveira', até onde eu sei. Eu pelo menos, faço meus próprios
scripts utilizando pod2html. No entanto eu imagino que o pessoal mais novo
já faça algo mais interessante que isto, certo pessoal?



Cheers!


2012/12/18 Tiago Peczenyj <tiago.peczenyj em gmail.com>

> 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
>
> _______________________________________________
> Rio-pm mailing list
> Rio-pm em pm.org
> http://mail.pm.org/mailman/listinfo/rio-pm
>



-- 
André Garcia Carneiro
Software Engineer
(11)982907780
-------------- Próxima Parte ----------
Um anexo em HTML foi limpo...
URL: <http://mail.pm.org/pipermail/rio-pm/attachments/20121218/4ffe5668/attachment.html>


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