Gerador de documentação do PHPDoc dentro ou fora do Eclipse?

Estou desenvolvendo com Eclipse + PDT. Eu tenho adicionado comentários do phpdoc no meu código, mas na verdade nunca gerou uma documentação resultante no Eclipse. Como devo fazê-lo – existe alguma funcionalidade no Eclipse, ou a geração do documento deve ser feita externamente?

Para gerar a documentação, você deve usar o phpDocumentor , que pode ser instalado como um pacote PEAR.

Então, você precisa chamá-lo da linha de comando; Nunca vi isso chamado do Eclipse PDT, na verdade.

Uma ótima solução é ter uma plataforma de continuous integration (usando phpUnderControl , por exemplo) e integrar a criação do phpdoc em seu arquivo de configuração de compilation; desta forma, o phpdoc é gerado toda vez que alguém comete (ou uma vez por dia, ou quando quiser ^^) .

No Eclipse PDT, você pode chamar “ferramentas externas” (veja “Executar> Ferramentas Externas” no menu); isso permitiria que você iniciasse o comando phpdoc (como você faz da CLI); mas definitivamente não é tão fácil de usar como o que o Zend Studio oferece – e não o mesmo preço, embora ^^

Outra ótima ferramenta para gerar documentação é o ApiGen . Não precisa de instalação com PEAR (mas inclui) e pode ser usado como um pacote autônomo.

Sim, há um assistente para fazer isso em Zend. Confira este breve guia .

Alternativamente, você pode criar uma configuração de boot externa para invocar o padrão phpDocumentor .

  1. Selecione Executar-> Ferramentas Externas-> Configurações de Ferramentas Externas …
  2. No painel esquerdo, selecione Programa e, em seguida, o ícone novo (ícone mais à esquerda acima do painel).
  3. No painel da mão direita, selecione a guia Principal.
  4. Digite generate_doc no campo Nome :.
  5. Digite o caminho para a ferramenta phpdoc cli no campo Localização :.
  6. Insira todos os argumentos necessários no campo Argumentos, por exemplo, para a input atual do projeto $ {project_loc}.
  7. Para executar a configuração externa, selecione Executar.

Para executar novamente a configuração, você possui algumas opções:

  1. Selecione o ícone Ferramentas Externas no ícone de ferramentas externas da barra de menu http://img.bestphpide.com/documentation/ ” e clique em generate_doc
  2. Selecione Executar-> Ferramentas Externas-> generate_doc
  3. Pressione Alt + R, E, 1 (assumindo que generate_doc é o primeiro item da lista, caso contrário, escolha o número apropriado)
Intereting Posts