<html><head><style type="text/css"><!-- DIV {margin:0px;} --></style></head><body><div style="font-family:times new roman, new york, times, serif;font-size:12pt"> Oi amigos, boa tarde...<br> Estou documentando um sistema, utilizando o POD. Até aí blzinha. (A propósito da discussão que está rolando sobre o assunto; eu particularmente utilizo POD inline).<br> Acontece que fiz com acentuação esta documentação. Meu locale padrão está com : pt_BR.UTF-8 e na máquina remota (onde roda o sistema) também.<br> Quando executo : perldoc Module.pm<br> Ele mostra aqueles caracteres voadores não identificados.<br> Tenho o hábito de documentar "in english", porém, este sistema precisa estar em bom português.<br> É possível utilizar acentuação ?<br> Desde já muitíssimo obrigado.<br><div> </div>Daniel
® Antunes<br><em><font color="#007f40">profissional de informática</font></em><br><em><font color="#007f40"></font></em><em><font color="#007f40">gnu/linux user</font></em> #238553<div style="font-family: times new roman,new york,times,serif; font-size: 12pt;"><br><br><div style="font-family: times new roman,new york,times,serif; font-size: 12pt;">----- Mensagem original ----<br>De: Lucas F. Rosada <lucasrosada@gmail.com><br>Para: saopaulo-pm@mail.pm.org<br>Enviadas: Sexta-feira, 11 de Janeiro de 2008 15:30:45<br>Assunto: Re: [SP-pm] Documentação de cabeçalho de rotinas<br><br><div>Otávio,</div>
<div> </div>
<div>Quando disse "documentar as funções e manter o POD do script em geral (com sinópse, autor, etc.) sem se ater às funções", eu estava me referindo a fazer um comentário com "#" no cabeçalho da função, explicando seus detalhes (para o desenvolvedor) e no POD (no fim do script) documentar estritamente o uso do script.
</div>
<div>Quanto a isso, inclusive, há um comentário no perlmonks no qual o usuário defende esse mecanismo de comentário acima (além de também questionar sobre a poluição visual que o POD Inline provoca). Acredito, sim, que a documentação deve ser completa e auto-explicativa, dispensando (na maior medida possível) a leitura do código-fonte.
</div>
<div> </div>
<div>Agora, retomando uma das perguntas: existe algum padrão que vocês usam para documentar as rotinas?</div>
<div>Existe algum modo bem difundido de documentação diferente do POD, que polua menos o script e permita, por exemplo, gerar man pages dos comentários?</div>
<div> </div>
<div>Desde já fico grato pelas respostas.</div>
<div> </div>
<div>Lucas.<br><br></div>
<div class="gmail_quote">On Jan 11, 2008 1:34 PM, Otávio Fernandes <<a rel="nofollow" ymailto="mailto:otaviof@gmail.com" target="_blank" href="mailto:otaviof@gmail.com">otaviof@gmail.com</a>> wrote:<br>
<blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0px 0px 0px 0.8ex; padding-left: 1ex;">Lucas,<br><br>Nao deveria ser ao contrario ?!<br><br>A leitura de um fonte para saber o que o script faz eh errado, pois
<br>consome muito mais tempo, e consequentemente, uma manutencao de rotina<br>tambem vai consumir. O ideal eh que somente com a documentacao do<br>script, no comeco de cada funcao e do arquivo, te deem toda a<br>informacao do que o script faz, e como ele o faz. O comentario vai ser
<br>muito util na hora de alterar uma rotina, porem o excesso dele, no meu<br>ponto de vista, atrapalha.<br><br>um abraco,<br><font color="#888888"><br>--<br> | --<br> | Otávio Fernandes < otaviof | gmail | com ><br>
| FreeBSD 7.0-PRERELEASE && GNU/Linux User: 283.396<br> | (( Especial Programação )) <a rel="nofollow" target="_blank" href="http://geekbr.podcastbrasil.com/">http://geekbr.podcastbrasil.com/</a> -- 0.15<br> | --<br></font>
<div>
<div></div>
<div class="Wj3C7c">_______________________________________________<br>SaoPaulo-pm mailing list<br><a rel="nofollow" ymailto="mailto:SaoPaulo-pm@pm.org" target="_blank" href="mailto:SaoPaulo-pm@pm.org">SaoPaulo-pm@pm.org</a><br><a rel="nofollow" target="_blank" href="http://mail.pm.org/mailman/listinfo/saopaulo-pm">
http://mail.pm.org/mailman/listinfo/saopaulo-pm</a><br></div></div></blockquote></div><br><br clear="all"><br>-- <br>"O que há aí para mim?"
</div><br></div></div><br>
<hr size=1>Abra sua conta no <a href="http://br.rd.yahoo.com/mail/taglines/mail/*http://br.mail.yahoo.com/">Yahoo! Mail</a>, o único sem limite de espaço para armazenamento!
</body></html>