PHP formato Comentário: auto gerado ou Usuário criado?

Question

Eu sempre vi esses comentários de cabeçalho em php, e muitas vezes se perguntou se algum software foi usado para configurá-los? I parecem JavaDoc recordação ou algo assim? Mas eu não tenho certeza se isso é gerado auto? Ou este é apenas algum tipo de padrão de documentação?

O exemplo abaixo é de CodeIgniter :

/**
 * CodeIgniter
 *
 * An open source application development framework for PHP 4.3.2 or newer
 *
 * @package     CodeIgniter
 * @author      ExpressionEngine Dev Team
 * @copyright   Copyright (c) 2008, EllisLab, Inc.
 * @license     http://codeigniter.com/user_guide/license.html
 * @link        http://codeigniter.com
 * @since       Version 1.0
 * @filesource
 */

Eu realmente gostaria de melhorar o meu comentando e eu sinto isso seria uma ótima forma para meus projetos.

Answer 1

É phpDoc que é usado por algumas estruturas com reflexão para dinamicamente entender e classes de uso (pelo código si).

IDEs também vai usá-lo para o preenchimento automático, mostrando argumentos de função, etc. Boa coisa a saber se o seu IDE fornece as funções para o Quadro seu uso, mas não o código que você escreve.

do PHP Reflection API

Zend Framework de extensão (incluindo dockblocks)

Guia (Usando docblock' ... para que possam ser apanhados por Comentário do CodeIgniter IDEs')

docblock Descrição na phpdoc.org ( ligada a partir de Guia de Estilo do CI)

Answer 2

Esses comentários seguem o padrão de phpdoc e pode ser usado para gerar automaticamente uma documentação do seu código. Você pode ver um exemplo de uma tal documentação aqui .

Enquanto alguns IDEs tem suporte para fazer escrevê-los mais fácil, o conteúdo real é escrito à mão pelos programadores.

Answer 3

Alguns IDE pode colocá-lo automaticamente, mas as pessoas muitas vezes apenas digite-o.

em PHP, PHP Documentor , você pode ver um quickstart guiar aqui .

Esta irá analisar o seu código-fonte e criar documentação com base em seus comentários sobre seus arquivos, classes e funções.

Answer 4

Esta é JavaDoc e é provavelmente gerado automaticamente por um IDE.