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

Wendel Scardua wendelscardua em gmail.com
Sexta Janeiro 11 01:41:16 PST 2008


Eu prefiro o "Inline POD" :-)

Ao começar a ver o código você já se depara com a documentação do mesmo, e a
documentação dos métodos vem logo antes da declaração dos mesmos... Se eu
fosse deixar a doc dos métodos longe deles, eu acabaria deixando eles "fora
de sincronia" (ex: adicionando|removendo|renomeando um método|parâmetro e
esquecendo de fazer o pod refletir a mudança).

Aliás, acabei de ver o post do perlmonks, o primeiro comentário fala
justamente isso que eu falei... E eu concordo com outro ponto que o cara
menciona: pod é feio pra caramba...

[]s
Wendel

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

> 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
>
>
-------------- Próxima Parte ----------
Um anexo em HTML foi limpo...
URL: http://mail.pm.org/pipermail/saopaulo-pm/attachments/20080111/b54aaa63/attachment.html 


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