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