você está aqui: Home  → Arquivo de Mensagens Programação Shell Linux: Inscrições Abertas

phpDocumentor - A solução completa em documentação em PHP.

Colaboração: Ricardo Henrique Cândido

Data de Publicação: 29 de Maio de 2005

O phpDocumentor é uma ferramenta para auto-documentação utilizado com a linguagem php. Similar ao Javadoc, e escrito em php.

O phpDocumentor pode ser ainda usado na linha de comando (shell) ou atraves de uma interface web para criar documentação profissional do codigo php de sua aplicação.

O phpDocumentor tem suporte para a linkagem entre documentetos, incluindo a criação de documentos a niveis de usuarios como tutoriais e criação de codigo destacado com referência para documentação geral de php.

As tags para a criação da documentação são inseridas atraves dentro de comentários.

O phpDocumentor usa um sistema de templates extensiveis para mudar os comentarios do codigo fonte em um formato util para que possamos ler. Esse sistema permite a facil criação para ler o documento em 15 diferrentes HTML designers, formato PDF, formato Windows Helpfile (CHM), e em DocBook XML. Você tambem podera criar seu proprio template.

Caracteristicas

  • suporta criação da documentação em HTML, PDF, CHM e XML DocBook.
  • muito rápido.
  • pode ser usado em linha de comando e interface web.
  • a documentação pode ser completamente customizavel com base em templates inteligentes.
  • e muitas outras.

Exemplo de codigo em php

— 1     /**
— 2      * demonstração de tags.
— 3      * @author Ricardo Henrique Cândido (definindo o autor)
— 4      * @version 1.0 (definindo a versao)
— 5      */
— 6      <?
— 7       seu codigo php


Veja a relação completa dos artigos de Ricardo Henrique Cândido