Barra de pesquisas do Google

Google

segunda-feira, 20 de dezembro de 2010

Documentando código com Phpdocumentor

Resolvi fazer esse breve post só dar uma ajudinha rápida aos que estiverem iniciando com o PhpDocumentor, para não perderem tempo como eu perdi no começo.
Então... Se vc estiver pensando em documentar seu código Php, na página oficial do PhpDocumentor tem explicando os passos de como fazer... Você pode instalar no seu servidor, ou usar uma interface web deles pra isso, onde vc baixa os arquivos e monta num servidor. É recomendado que vc primeiro realize testes antes de fazer com o código principal, pra vc não correr o risco de fazer besteira e "corromper" seu código.
Então... esse post é só pra dar a dica de que vc não precisa baixar nada disso... basta usar a interface web disponível aqui .
As imagens abaixo são para uma breve orientação:
Acima você viu como selecionar os arquivos pra documentar. A figura abaixo é referente à aba 'output', onde se especifica o diretório de saída onde se encontrará a documentação gerada.
O bacana é que ela sai em HTML, onde você pode add estilos e deixar tudo bem organizado.

Nenhum comentário:

Sign by Dealighted - Coupons & Discount Shopping