Arquivo da Categoria ‘PHP’

3 junho, 2010 | 2 comentários

Documente seu código PHP usando o PHPDoc

O phpDocumentator é uma ferramenta para geração de documentação de código feito na linguagem de programação PHP.

Um pouco sobre o phpDoc:

  • Pode ser usado tanto via linha de comando quanto via interface web.
  • Pode exportar para HTML, XML, PDF e para CHM (helpfile do Windows).
  • Bastante customizável (usa templates). A interface web tem um preview de cada tema.
  • Linka classes e faz herança entre elas.
  • Documentação de arquivos README/CHANGELOG/INSTALL/FAQ

Veja mais features na página oficial.

Download

Versão 1.4.3 .zip | 1.4.3 .tgz (verifique se há alguma versão mais recente)

Instalação (Linux e Windows)

  • Esteja certo que você tem o PHP rodando corretamente na sua máquina. Para a interface web, você precisa de um servidor. Para Windows, indico o tutorial do Pedro Rogério chamado Instalar Apache+PHP+MySQL no Windows 7/Vista/XP e para Linux existem vários artigos por aí.
  • Extraia o arquivo .zip ou .tgz que você baixou.
  • No Linux: sugiro colocar a pasta do phpdoc em /opt (faça isso como super usuário) e adicioná na variável $PATH do sistema: $ echo ‘PATH=$PATH:/opt/php-doc’ >> ~/.bashrc && source ~/.bashrc
  • No Windows: coloque o caminho da pasta extraída no PATH do sistema (configurações avançadas) para que possa executá-lo apenas com o comando phpdoc (referente ao arquivo phpdoc.bat).
  • Para rodar a interface web, coloque a pasta que foi extraída dentro do seu diretório de documentos do apache (ex: c:/apache/htdocs/php-doc ou /var/www/php-doc) e abra a página no seu navegador com http://localhost/php-doc, por exemplo.

Clique aqui para ler o post completo