0

PHPDOC – Documentando bem seu código.

criado por leo genilhu em 17/07/2006 6:46pm
Olá pessoal, depois de um bom tempo sem escrever aqui volto a todo vapor com uma série de artigos sobre documentação.

Hoje vamos falar um pouco sobre documentação de códigos php usando a ferramenta PHPDoc ou PHPDocumentor. O PHPDoc foi baseado no JAVADoc da Sun e tem como objetivo padronizar a documentação de códigos PHP. Ele lê o código e analisa gramaticalmente procurando por tags especiais. A partir delas extrai toda documentação usando diferentes formatos (pdf, xml, html, chm Windows help e outros). Todas as tags especiais são escritas dentro do comentários do php /* comentários */ e necessariamente começam com o @ (arroba).

Descrição de algumas tags especiais:

@access Especifica o tipo de acesso(public, protected e private).
@author Especifica o autor do código/classe/função.
@copyright Especifica os direitos autorais.
@deprecated Especifica elementos que não devem ser usados.
@exemple Definir arquivo de exemplo, $path/to/example.php
@ignore Igonarar código
@internal Documenta função interna do código
@link link do código http://www.exemplo.com
@see
@since
@tutorial
@name Especifica o apelido(alias).
@package Especifica o nome do pacote pai, isto ajuda na organização das classes.
@param Especifica os paramêtros muito usado em funções.
@return Especifica o tipo de retorno muito usado em funções.
@subpackage Especifica o nome do pacote filho.
@version Especifica a versão da classe/função.
Inline { @internal


Comentários:

Mostrando 1 - 8 de 8 comentários
parabens, bem explicado, o exemplo ajudou basttante.
16/03/2008 2:25pm (~8 anos atrás)

Diego Hellas disse:
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!
27/09/2006 5:58pm (~10 anos atrás)

Pablo Vanni disse:
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?
21/08/2006 7:11pm (~10 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 (~10 anos atrás)

Keitty Amador disse:
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 (~10 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
25/07/2006 7:45am (~10 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.
18/07/2006 10:37am (~10 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 (~10 anos atrás)

Novo Comentário:

(Você pode usar tags como <b>, <i> ou <code>. URLs serão convertidas para links automaticamente.)