Articles of documentação

Qualquer coisa melhor do que o PHPDoc lá fora?

Alguém usa qualquer outra coisa para documentar seu código PHP do que o PHPDoc? Existem ferramentas que lêem a mesma syntax de documentação, mas dão uma saída mais rica?

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?

Sphinx para documentação do código php

Sphinx é uma biblioteca Python para gerar documentação agradável de um conjunto de arquivos de texto formatados ReST. Não é a ferramenta usada para pesquisa de texto completo Também estou plenamente consciente das ferramentas doxygen / phpdoc. Estou tentando descobrir se existe uma maneira de usar o Sphinx para documentar projetos php? ou mesmo outras […]

Por que as funções embutidas em PHP são chamadas de forma aleatória?

Parece que não há um padrão real para a forma como as funções são chamadas, str_replace, strrpos, strip_tags, stripslashes são apenas alguns. Por que esse é o caso? EDITAR – isso não significava como um post tipo “troll” – apenas algo que eu penso toda vez que eu uso o idioma!

Não é possível excluir diretórios do PHPDocumentor

Estou tentando executar o PHPDocumentor na configuração do meu WAMPServer. Funciona bem, mas eu gostaria de excluir determinados diretórios, como \ sqlbuddy \ que não contém meu próprio código. Ironicamente, o PHPDocumentor parece estar ignorando minha opção – ignorar. Eu tentei várias maneiras de expressar o mesmo, mas com o mesmo resultado. Abaixo está o […]

Devo usar @return self, this ou a class atual?

Eu tenho um método que retorna o object atual, como eu documento isso? /** * set something * * @return this */ public function setSomething(){ // … return $this; } Ou devo fazer @return self ou @return Current_Class_Name ?

Como documentar methods mágicos (_call e _callStatic) para IDEs

Depois de muitos anos felizes codificando no bloco de notas ++ e sublime, fui aconselhado a dar um IDE do PHP. Estou tentando phpStorm e parece legal. A conclusão e a documentação do código são uma ótima característica, mas não estão funcionando para mim quando os methods mágicos são usados. Existe algum trabalho para obter […]

Como você documenta suas funções e classs PHP no inline?

Eu sei que existem muitos padrões diferentes para a documentação inline do código PHP. Veja o que eu quero dizer com documentação interna, e corrija-me se houver um termo melhor: /** * This is the description for the class below. * * @package my-package * @subpackage my-subpackage * @author my-name * @version my-version * … […]

Existem ferramentas do analisador DocBlock do PHP disponíveis?

Gostaria de criar alguns sites de documentação mais pequenos, mas muito personalizados, para alguns projetos. PhpDocumentor é muito bom, mas é muito pesado. Pensei em tentar ajustar os modelos para isso, mas depois de passar apenas alguns minutos procurando isso, decidi que seria muito trabalho. Idealmente, eu gostaria de ver algo para o qual eu […]

Geração Automática de Documentação PHP?

Para o ActionScript 2, usei o NaturalDocs . No entanto, tem um suporte bastante fraco para o PHP. Eu olhei até agora no Doxygen e no phpDocumentor , mas sua produção é bastante feia na minha opinião. Alguém tem alguma experiência com a geração automática de documentação para o PHP? Eu preferiria usar tags de […]