Oi Mongers,
vocês usam o perl POD para documentar seus scripts e pacotes, ou há outra
estratégia de documentação mais recomendada.
Pergunto, porque já usei (bem pouquinho) o POD, só que com ele eu perco a
gambiarra de comentar pedaços grandes de código usando o =begin ... =cut.
Existe outra est
Costumo comentar os blocos de código assim:
=for comment
$_='while(read+STDIN,$_,2048){$a=29;$b=73;$c=142;$t=255;@t=map{$_%16or$t^=$c^=(
$m=(11,10,116,100,11,122,20,100)[$_/16%8])&110;$t^=(72,@z=(64,72,$a^=12*($_%16
-2?0:$m&17)),$b^=$_%64?12:0,@z)[$_%8]}(16..271);if((@a=unx"C*",$_)[20]&48){$h
=5;$
Isso não é gambiarra se vc usar certo.
agora a vantagem do pod é a documentação estar no mesmo arquivo que o seu
módulo. assim vc não precisa editar dois ou mais arquivos para fazer uma
simples alteração e evita que a documentação fique obsoleta.
e fica pratico com o perldoc Seu::Modulo
agora vc
Obrigada, Stanislaw, Aureliano e Tiago!
Vou estudar estes links que o Aureliano passou.
Eu só usei até agora o POD depois do _END_ , mas vi que ele pode ser muito mais
útil se eu usar desde o cabeçalho do script, poupando assim meus comentários
tipo ### sobre cada função.
Vou preparar uma apres
Eu tenho as minhas duvidas. Para pacotes sim é muito util pois cada função
que vc esta exportando ou cada método é importante de ser documentado pois
vai ser utilizado fora dali.
Agora se eu tenho um script ou uma aplicação eu gosto de colocar no final
para ter uma noção clara de todo o codigo.
2
Alias de uma olhada na função pod2usage
2012/12/18 Tiago Peczenyj
>
> Eu tenho as minhas duvidas. Para pacotes sim é muito util pois cada função
> que vc esta exportando ou cada método é importante de ser documentado pois
> vai ser utilizado fora dali.
>
> Agora se eu tenho um script ou uma apli
Nicole
POD é a muito tempo o esquema de documentação 'oficial', principalmente se
você pensar em publicação(CPAN). É o que o CPAN aceita para publicações.
Mas, provavelmente, estou bem mal-informado sobre isso. Melhor dar uma
olhada, caso pretenda publicar algo no CPAN.
De qualquer forma, a muit
BEM LEMBRADO!
O pod alem de documentação vc pode usar para gerar conteudo. Como artigos
para um blog - é o formato que o equinócio utiliza.
2012/12/18 Andre Carneiro
> Nicole
>
>
> POD é a muito tempo o esquema de documentação 'oficial', principalmente se
> você pensar em publicação(CPAN). É o