0
PHPDOC – Documentando bem seu código.
Como instalar o PHPDoc ?
Há dois metódos oficiais para a instalação do PHPDocumentor,
Você pode baixar o PHPDoc direto do site sourceforge.net.
Para instalar pasta descompactar o arquivo .zip e criar um diretorio de trabalho phpdoc.
Outra forma é usar a versão distribuída no pacote PEAR.
Para instalar basta executar o comando abaixo
$ pear install PhpDocumentor
Como gerar relatórios de phpdoc usando o ZEND ?
O Editor PHP ZEND vem com uma interface integrada para gerar seus relatórios de documentação.
Para isso bastas seguir as instruções através do menu tools --> PHPDocumentor.
Outra forma de gerar a documentação e via shell do linux.
$phpdoc -o HTML:frames:earthli -f arquivo.php -t docs
Mais curiosidades consulte a documentação no site oficial phpdoc.org.
Gostaria também de acrescentar que a partir de Maio estarei escrevendo em uma coluna especifica no SQLMagazine onde falarei entre outras coisas de aplicações open source e banco de dados.
Um abraço a todos e até aproxima.
Leo Genilhu
Fontes: www.phpdoc.org
http://pear.php.net/package/PHPDoc
http://sourceforge.net/projects/phpdoc/
Comentários:
Mostrando 1 - 8 de 8 comentários
parabens, bem explicado, o exemplo ajudou basttante.
16/03/2008 2:25pm
(~17 anos atrás)
Eu já tinho ouvido falar muito o phpdoc, que é descendente do java doc correto? mas não tinha a mínima idéia de como funcionava, ams agora tive uma visão bem boa de como ele funciona.
Valeu!
Valeu!
27/09/2006 5:58pm
(~18 anos atrás)
Eu uso a IDE da Zend e quando tento gerar a documentação em formato help do windows ele não funciona :(
Alguem já teve o mesmo problema ow sabe resolver?
Alguem já teve o mesmo problema ow sabe resolver?
21/08/2006 7:11pm
(~18 anos atrás)
Bem amigos sou novo na area, mas tenho muito interesse em aprender e gostaria de saber mais como devo usar, como funciona essa documentação, isso é um programa que eu tenho que pegar pra fazer isso para mim, gostaria de mais detalhes sobre isso. VLW
05/08/2006 11:44am
(~18 anos atrás)
Muito bom esse artigo, eu não tinha o costume de documentar o código php sempre documentei a regra de negócio somente.
02/08/2006 4:13am
(~18 anos atrás)
Para mais aprofundamento tem tb um artigo sobre o PHP Doc escrito pelo Rodrigo Rodrigues...
Segue o link: http://phpbrasil.com/articles/article.php/id/916
Att,
Wescley Costa
Segue o link: http://phpbrasil.com/articles/article.php/id/916
Att,
Wescley Costa
25/07/2006 7:45am
(~18 anos atrás)
Bom seu artigo esta otimo, é muito bom os programadores novos começarem a aprender a documentar seus codigo.
Tem amigos meus que dizem: fazer um software é facil dificil e documentar tudo.
Tem amigos meus que dizem: fazer um software é facil dificil e documentar tudo.
18/07/2006 10:37am
(~18 anos atrás)
vale lembrar tbm que este mesmo padrao de escrita de codigo.. eh tbm utilizado nos pacotes da pear http://pear.php.net/manual/en/standards.php
18/07/2006 10:00am
(~18 anos atrás)