Download phpDocumentor - download do código-fonte phpDocumentor

phpDocumentor

Outras categorias

v3.5.3

Baixar

phpDocumentor

O que é phpDocumentor?

phpDocumentor é a ferramenta de documentação de fato para projetos PHP, oferecendo uma solução robusta para gerar documentação abrangente sem esforço. Ao analisar seu código-fonte PHP e comentários do DocBlock, o phpDocumentor gera um conjunto completo de documentação de API, tornando-o uma ferramenta indispensável para desenvolvedores que buscam bases de código claras e bem documentadas.

Além de sua habilidade na documentação de API, o phpDocumentor vai além, fornecendo recursos adicionais. Está equipado com a capacidade de criar diagramas UML, tornando-o uma ferramenta versátil para visualizar a estrutura do código. Além disso, phpDocumentor oferece um analisador de linguagem de marcação completo, suportando sintaxe RestructuredText e Markdown. Essa flexibilidade permite documentar seu projeto usando a linguagem de marcação que melhor atende às suas preferências.

Um recurso notável do phpDocumentor é sua capacidade de incluir partes da documentação da API diretamente na documentação do RestructuredText. Essa integração garante que sua documentação e código permaneçam sincronizados, economizando tempo e esforço na manutenção da documentação do projeto precisa e atualizada.

Inspirado em seus antecessores, phpDocumentor 1 e JavaDoc, o phpDocumentor continua inovando, mantendo-se atualizado com as mais recentes tecnologias e recursos da linguagem PHP. Este compromisso garante que os desenvolvedores tenham acesso à melhor experiência de documentação possível, alinhando-se às práticas modernas de desenvolvimento.

Neste guia, exploraremos os vários recursos do phpDocumentor, desde sua funcionalidade principal na geração de documentação de API até seus recursos avançados na análise de linguagens de marcação. Quer você seja um desenvolvedor iniciante ou experiente, o phpDocumentor é seu aliado na criação de projetos PHP bem documentados, fáceis de manter e compreensíveis.

phpDocumentor v3 (estável)

v3 é a versão estável mais recente.

Documentação

Para informações mais detalhadas, você pode verificar nossa documentação online em https://docs.phpdoc.org/.

Características

phpDocumentor suporta o seguinte:

Compatível com PHP 7.0+ , suporte completo para Namespaces, Closures e muito mais são fornecidos.
Docblock sobre tipos , docblocks podem ser mais explícitos sobre tipos, nem todos os formatos são suportados pelo php nativo.
Mostra qualquer tag , algumas tags adicionam funcionalidades adicionais ao phpDocumentor (como @link).
Baixo uso de memória , pico de uso de memória para projetos pequenos é inferior a 20 MB, projetos médios 40 MB e estruturas grandes 100 MB.
Análise incremental , se você mantiver o arquivo de estrutura de uma execução anterior, obterá um aumento adicional de desempenho de até 80% além do aumento de velocidade de processamento mencionado acima.
Fácil construção de templates , se você quiser fazer uma marca basta chamar 1 tarefa e editar 3 arquivos.
Processo de duas etapas , o phpDocumentor primeiro gera um cache com a estrutura do seu aplicativo antes de criar a saída. Se desejar, você pode usá-lo para alimentar suas próprias ferramentas ou formatadores!
Suporte a genéricos , com análises mais estáticas em tipos php tornaram-se mais complexos. phpDocumentor entende esses tipos. E irá renderizá-los como tipos de primeira classe.

Instalação

PhpDocumentor requer PHP 8.1 ou superior para ser executado. No entanto, o código de versões anteriores do PHP pode ser analisado.

Todos os modelos fornecidos com o phpDocumentor possuem suporte para diagramas de classes baseados na base de código de leitura. Isso exigirá que o aplicativo [PlantUml] esteja instalado na máquina que executa o phpDocumentor. A renderização dos diagramas de classes usando [PlantUml] é opcional e os avisos sobre a falta de [PlantUml] podem ser ignorados. No entanto, sua documentação conterá alguns links inativos neste caso. O diagrama de classes será criado com a opção --setting=graphs.enabled=true .

Existem 4 maneiras de instalar o phpDocumentor:

Usando phive (recomendado)
Usando o PHAR (instalação manual)
Através do Docker
Através do Compositor

Usando Phive

$ phive install phpDocumentor --trust-gpg-keys 8AC0BAA79732DD42

Para obter mais informações sobre o phive, dê uma olhada no site deles. Agora que você tem o phpDocumentor instalado, ele pode ser executado assim:

php tools/phpDocumentor

Usando o PHAR

Baixe o arquivo phar em https://github.com/phpDocumentor/phpDocumentor/releases
Você pode executar o phar assim: php phpDocumentor.phar

Através do Docker

$ docker pull phpdoc/phpdoc
$ docker run --rm -v $(pwd):/data phpdoc/phpdoc

Via Composer (não recomendado)

Mas espere? E o compositor?

Ah, você descobriu nosso segredo. Existe um pacote phpdocumentor compositor que você pode usar para instalar o phpDocumentor.

Porém: phpDocumentor é uma aplicação complexa, e suas bibliotecas são utilizadas em inúmeras outras bibliotecas e aplicações (2 de nossas bibliotecas possuem mais de 150 milhões de downloads cada); e isso significa que as chances de conflito entre uma de nossas dependências e a sua são altas. E quando digo alto, é muito alto.

Portanto, por causa do acima exposto: não endossamos nem apoiamos ativamente a instalação do phpDocumentor usando o Composer.

Como usar o phpDocumentor?

A maneira mais fácil de executar o phpDocumentor é executando o seguinte comando:

$ phpdoc run -d <SOURCE_DIRECTORY> -t <TARGET_DIRECTORY>

Este comando analisará o código-fonte fornecido usando o argumento -d e o enviará para a pasta indicada pelo argumento -t .

phpDocumentor suporta uma ampla gama de opções para configurar a saída de sua documentação. Você pode executar o seguinte comando ou verificar nosso site para obter uma lista mais detalhada das opções de linha de comando disponíveis.

$ phpdoc run -h

Arquivo(s) de configuração

phpDocumentor também suporta o uso de arquivos de configuração (chamados phpdoc.xml ou phpdoc.dist.xml por padrão). Consulte a documentação para ver o formato e as opções suportadas.

Construções noturnas

PhpDocumentor não possui lançamentos noturnos. No entanto, durante cada pipeline, um artefato phar é construído. Se você quiser testar a versão mais recente do phpDocumentor, dê uma olhada na seção de ações deste repositório. Cada fluxo de trabalho de controle de qualidade bem-sucedido tem uma seção Artefatos na parte inferior com o artefato phar construído.