[SP-pm] Documentação de cabeçalho de rotinas

Lucas F. Rosada lucasrosada em gmail.com
Quinta Janeiro 10 17:21:55 PST 2008


Salve a todos!

Estive lendo sobre POD e percebi que é boa prática documentar um script ou
módulo no estilo de uma man page, no entanto sem deixar para trás cada um
dos métodos públicos existentes nele. Porém, nos últimos tempos programei em
C e Java, onde é costume comentar uma função ou método logo acima de seu
cabeçalho.
Assim, surgiu a dúvida: usar só documentação em POD no fim do módulo,
documentar as funções e manter o POD do script em geral (com sinópse, autor,
etc.) sem se ater às funções ou manter as duas documentações completas?
Existe algum padrão (ou boas práticas) de documentação de rotinas em perl
(contendo informações como descrição, parâmetros de entrada/saída, retorno,
etc.)?

Agradeço a todos da lista.

Um abraço.

Lucas.

-- 
"O que há aí para mim?"
-------------- Próxima Parte ----------
Um anexo em HTML foi limpo...
URL: http://mail.pm.org/pipermail/saopaulo-pm/attachments/20080110/4a9da75e/attachment.html 


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