PHPDocumentator ou simplismente PHPDocs, é uma ferramenta que serve para gerar documentação de código-fonte de programas escritos em PHP. O PHPDocs também foi escrito em PHP, e é baseado no JavaDocs, uma ferramenta com função similar, mas para programas Java.
Com o PHPDocumentator, pode-se gerar documentação de código-fonte em vários formatos, incluindo HTML, CHM e PDF. O programa possui suporte tanto a linha de comandos, como uma interface Web para a geração de tal documentação.
Para gerar a documentação do projecto indicado, o PHPDocs rastrea todos os arquivos do projecto, em busca de tags especiais que devem ser colocadas em comentários de classes, funções, arquivos e outros. É a partir destas tags que o PHPDocs irá gerar uma documentação mais eficiente do projecto. Mesmo que não existam tais tags, a documentação é gerada, mas sem informações reelevantes sobre cada parte do código. Testei o PHPDocs com um projecto que eu comecei a desenvolver antes mesmo de conhecer as tags especiais, e o software se mostrou muito eficiente.
As tags especiais do PHPDocs começam todas com o sinal @, e podem ser buscadas no manual oficial do PHPDocs. Um exemplo de uma tag especial do PHPDocs é a tag @author, que indica o autor do código a que se está a documentar.
Baixando e Instalando o PHPDocs
Para usar o PHPDocumentator, você terá que ter a ferramenta instalada no seu sistema. Existem duas opções de instalação do PHPDocs, uma é baixar o pacote do site oficial do PHPDocs outra é a partir do PEAR. Eu apenas testei a primeira, é a mais simples e eu aconselho! Então baixe o PHPDocumentator , que também está disponível na secção de downloads do Techmoz, e descompacte ele no directório raiz do seu Apache. Estamos colocando ele no HTDocs ou www do Apache para podermos usar a interface Web do software.
Depois de descompactado, apenas precisamos acessar o software a partir de um browser e seguir a instruções para a geração da documentação de projectos PHPDocs.
Agora que já sabe como instalar e acessar o PHPDocs, apenas precisa documentar bem os seus códigos PHP! O manual oficial do PHPDocs será uma boa opção de ajuda para isso.
Comentários Recentes