Gerando documentação de projetos PHP com o DocBlox

Publicado por Renato Mendes Figueiredo em 23/05/2011

[ Hits: 7.619 ]

 


Gerando documentação de projetos PHP com o DocBlox



No momento em que este tutorial foi escrito, o DocBlox se encontra na versão 0.9.5

Instalando o pear:

# aptitude install php-pear

Caso utilize o ZendServer o pear já está instalado, basta fazer um link do binário executando:

# ln -s /usr/local/zend/share/pear/bin/pear /usr/bin/

O binário PHP também deve estar disponível, caso utilize ZendServer basta fazer um link também:

# ln -s /usr/local/zend/share/pear/bin/php /usr/bin/

Adicionando os canais pear necessários:

# pear channel-discover pear.docblox-project.org
Adding Channel "pear.docblox-project.org" succeeded
Discovery of channel "pear.docblox-project.org" succeeded

# pear channel-discover pear.zfcampus.org
Adding Channel "pear.zfcampus.org" succeeded
Discovery of channel "pear.zfcampus.org" succeeded

# pear channel-discover pear.michelf.com
Adding Channel "pear.michelf.com" succeeded
Discovery of channel "pear.michelf.com" succeeded

Instalando pacote graphzviz:

# aptitude install graphviz

Deixar o comando `dot` disponível

Para testar execute:

# dot -h

Instalando o docblox:

# pear install docblox/DocBlox

Dependendo de quando você está instalando, ainda podem não haver pacotes estáveis, então será solicitado que você utilize o nome completo do pacote.

# pear install docblox/DocBlox-0.9.5

Acesse a pasta do DocBlox que está dentro do pear:

# cd /usr/local/php/pear/pear/DocBlox

Caso ZendServer:

# cd /usr/local/zend/share/pear/DocBlox

Verifique se dentro da pasta bin existe um arquivo chamado docblox.php, caso não exista, você pode baixa-lo do tgz presente no site pear.docblox-project.org e colocá-lo na pasta.

Feito isso basta parsear seu projeto: (-d é o diretório do projeto, -t é o diretório onde o structure.xml será gerado).

# php bin/parse.php -d /path/do/projeto -t /path/para/saida/do/xml

Agora basta transformar o xml na documentação em si, com template: (-s é o arquivo da estrutura, -t é a pasta de saída do html, --template é o template utilizado).

# php bin/transform.php -s /path/do/structure.xml -t /path/para/saida/do/html/ --template default

Você pode verificar os templates dentro da pasta data/templates e seus respectivos temas na pasta data/themes (Recomendo o template zend) Caso não goste do template utilize o comando transform novamente, pois o structure.xml já conterá os dados do projeto e não gastará processamento à toa.

Pronto, agora é só ir até o path da saída em HTML e acessar o index.html no seu navegador favorito.

Outras dicas deste autor
Nenhuma dica encontrada.
Leitura recomendada

CakePHP/HtmlHelper - Fazendo submit em formulário

Imprimindo dados enviados via PHP

PHP + Shell script

Variáveis variáveis em PHP

Lista de discussão de desenvolvedores PHP de Minas Gerais

  

Comentários

Nenhum comentário foi encontrado.



Contribuir com comentário




Patrocínio

Site hospedado pelo provedor RedeHost.
Linux banner

Destaques

Artigos

Dicas

Tópicos

Top 10 do mês

Scripts