PHP 编程/phpDocumentor
< PHP 编程
phpDocumentor 是一款使用内联注释自动生成易于阅读的软件文档的工具。
理想的文档有两个特性。首先，它应该易于维护和更新。其次，它应该易于读者阅读和浏览。这些往往是相互矛盾的目标。通过使用类似于 javadoc 和 phpDocumentor 的工具，你可以同时实现这两个目标。在编写文档时，只需在代码中插入特殊的注释。然后 phpDocumentor 将解析您的代码并生成易于使用的 HTML、DocBook 或 PDF 文档。
phpDocumentor 识别的注释是 C 风格的注释，在开始标签中有两个星号。
/** * */
这些被称为 DocBlock 注释。通过将它放在代码中的元素之前，phpDocumentor 将为该元素生成文档。例如，如果我想为 "RhesusMacaque" 类编写文档，我会在它之前放置一个 DocBlock。
/**
* This documents the Rhesus Macaque
*/
class RhesusMacaque
{
...
phpDocumentor DocBlock 有三个部分。第一部分是代码元素的简短摘要，不应超过一句话。接下来是几句话，更详细地描述元素，这是可选的。最后，是一系列的 标签.
/**
* The Rhesus Macaques rule the world through a secret conspiracy
*
* The Rhesus Macaques have been quietly watching human civilization
* for centuries. They have quietly influenced events through a
* variety of mechanisms. See class members for more details.
*
*/
class RhesusMacaque
{
...
标签可以插入 DocBlock 中，以更详细地描述代码元素的某些部分。它们提供数据，例如函数的返回值类型或代码的作者。它们用 "@" 符号标记，形式如下：
* @tagname properties
每个元素类型都有不同的标签集来描述它。参见 phpDocumentor 文档化的元素.
一个类似于
phpdoc --target /var/www/phpdoc --output "HTML:Smarty:php" --directory /var/www/app --filename **/*.php
的命令将从 /var/www/app 中找到的 PHP 文件生成文档。
有关输出格式的完整列表，请参见 PhpDocumentor 网站.
请注意，输出参数的值区分大小写。
- 由 --output 命令行选项指定的转换器 HTMLsmartyConverter 不是一个类
- "smarty" 中的 "s" 应该是大写。
- 模板目录 "/var/www/pear/PhpDocumentor/phpDocumentor/Converters/HTML/Smarty/templates/php/" 不存在
- "php" 应该是大写。