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

Lucas Mateus lucasmateus.oliveira em gmail.com
Sexta Janeiro 11 03:19:42 PST 2008


Eu acho mais interessante o "EOF POD" como mencionado eu tbm concordo que
POD eh feião, e o "Inline POD" acaba atrapalhando a leitura do código. Além
do POD utilizo bastante comentário, se outra pessoa quiser saber mais que
leia o POD. Particularmente acho assim mais interessante e um código mais
limpo pra ler.



Em 11/01/08, Wendel Scardua <wendelscardua em gmail.com> escreveu:
>
> 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
> >
> >
> _______________________________________________
> SaoPaulo-pm mailing list
> SaoPaulo-pm em pm.org
> http://mail.pm.org/mailman/listinfo/saopaulo-pm
>
-------------- Próxima Parte ----------
Um anexo em HTML foi limpo...
URL: http://mail.pm.org/pipermail/saopaulo-pm/attachments/20080111/c313c3ca/attachment.html 


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