PHPDoc入门
如果您遵循有关安装PHPDoc的教程，那么您可能想知道如何开始实际编写文档。PHPDoc将解析提供给它的所有文件，并查找注释块，然后将使用这些块为您的应用程序创建文档。有效的PHPDoc注释块必须以'/**'开头，每行都有'*'，并以'*/'结尾。注释必须出现在要注释的部分之前，并且解析器将忽略注释中任何不带'*'的行。
为了创建一些示例文档，我们将使用以下无用的类。
我们需要做的第一件事是创建文件注释，该注释旨在告诉人们此文件包含的内容。在此示例中，文件包含单个类定义和一个include语句。
/** * MyClass File (short description about the file) * * This file contains the definition of the file MyClass (a longer description about the file). * @author A.N. Other * @version 1.0 * @package MyPackage */注意@符号的使用。这称为标记，它允许PHPDoc将值分配给内部变量。因此，当我们使用@version时，我们正在为文件设置版本变量。
define()语句，函数，类，类方法以及类var，include()语句和全局变量都可以记录在案。因此，这里的下一步是记录include语句包含的内容。PHPDoc将尝试查找通过include或require语句引用的任何文件，并为这些文件生成文档。如果存在，将创建从该文件到文档中该文件的链接。
/** * Include the another_file.php file. */ include('another_file.php');接下来是我们的类定义，它由两种形式description(shortandlong)以及一些与类相关的标签相关的标签组成。
/** * This is a short description about the class. * * This is a longer description which should detail exactly what the class does. * @package test * @author A.N. Other * @version 1.0 * @copyright A copyright notice, if any. */ class MyClass { }该类中的两个变量也必须记录在案。
/** * A description of the variable. * @var integer */ public $publicVariable = 123; /** * This variable will only appear in our documentation is we set the --parseprivate attribute on the command line or it has been set up in the INI file. * @access private * @var string */ private $privateVaraible;最后，我们记录该功能。使用@param和@return这两个标签来记录功能。@param可以定义多次，并且是函数采用的参数的描述性列表。@return值只能定义一次，并描述函数返回的内容。如果从函数返回多个数据类型，则可以用竖线（|）分隔它们。
/** * This class either returns an integer or a string. * @param A description about the parameter $parameter * @return string|int This function returns a string or an integer. */ public function aFunciton($parameter) { //一些代码在这里... }要添加多个参数，只需在以@param开头的另一行中添加。
您可以使用以下命令在此文件上运行PHPDoc（假设您的项目保存在名为“MyProject”的文件夹中，并且您希望文档进入该目录中的“docs”）。
C:\MyProject>phpdoc-t"C:\MyProject\docs"-oHTML:frames:default-d"C:\MyProject"