PHP评论格式：自动生成或用户创建？

Question

我一直在php中看到这些标题注释，并且经常想知道是否使用了某些软件来设置它们？我似乎记得JavaDoc或什么？但我不确定这是否是自动生成的？或者这只是某种类型的文档标准？

下面的例子是从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 
*/ 

我真的想提高我的评论，我觉得这将是我的项目的最佳形式。

Answer 1

这是phpDoc这是由一些框架使用反射动态理解和使用类（由代码本身）。

IDEs也将它用于自动完成，显示函数参数等。好东西知道你的IDE是否为你使用的框架提供了这些功能，但不是你编写的代码。

PHP's Reflection API

Zend Framework Extension (including DocBlocks)

CodeIgniter's Comment Guide (Using DocBlock '...so they can be picked up by IDEs')

DocBlock Description on phpdoc.org (linked from CI's Style Guide)

Answer 2

这是JavaDoc，它可能是由IDE自动生成的。

Answer 3

一些IDE的可以把它自动的，但人们往往只是输入。

对于PHP是PHP Documentor，你可以看到一个quickstart guide here。

这将扫描您的源代码并根据您对您的文件，类和功能的评论创建文档。

Answer 4

这些注释遵循phpdoc的标准，可用于为您的代码自动生成文档。你可以看到这样一个文档here的例子。

虽然有些IDE支持简化写入，但实际内容是由程序员手写的。