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

[Lucas F. Rosada]

Olá!

RTFM para mim! Encontrei esse post no perlmonks que discute aproximadamente
o que perguntei: http://www.perlmonks.org/?node_id=94969
Eles debatem entre o "Inline POD" e o "EOF POD". Dois termos novos para mim
;)

De qualquer forma, gostaria de ouvir a opinião dos senhores quanto ao
"Inline POD" x "EOF POD" e, além disso, sobre padrões de documentação
comumente utilizados.

Um abraço.

Lucas

On Jan 10, 2008 11:21 PM, Lucas F. Rosada <lucasrosada em gmail.com> wrote:

> 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?"




-- 
"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/45542779/attachment.html