PHPDoctor 技术文档

本文档旨在帮助用户安装、使用和详细了解 PHPDoctor，这是一款 Javadoc 风格的 PHP 文档生成器。

1. 安装指南

PHPDoctor 可以通过 GitHub 克隆安装，但建议使用 Composer 在您的项目中安装：

{
    "require": "peej/phpdoctor": "2.0.5"
}

然后运行 Composer：

$ curl -s https://getcomposer.org/installer | php
$ composer.phar install

如果一切顺利，使用默认配置运行 PHPDoctor：

$ bin/phpdoc

2. 项目使用说明

PHPDoctor 将使用默认选项处理当前目录及以下所有 *.php 文件，除非提供了配置文件。

配置通过 PHP 风格的 ini 文件进行。如果当前目录中存在名为 phpdoctor.ini 的文件，PHPDoctor 会使用该文件，或者可以传递配置文件名作为第一个命令行选项。

PHPDoctor 支持以下配置指令：

• files - 要解析的文件名。可以是单个文件名或逗号分隔的文件列表。允许使用通配符。
• ignore - 要忽略的文件或目录名。可以是单个文件名或逗号分隔的文件列表。不允许使用通配符。
• source_path - 查找文件的目录，如果没有使用，PHPDoctor 将在当前目录（运行目录）中查找。
• subdirs - 如果不希望 PHPDoctor 查找每个子目录中的文件，请取消注释此行。
• quiet - 安静模式，仅显示警告和错误。
• verbose - 详细模式，执行期间输出额外信息。
• doclet - 选择用于生成输出的 doclet。
• doclet_path - 查找 doclet 的目录。Doclets 预期位于给定位置的以它们自己的名字命名的目录中。
• taglet_path - 查找 taglet 的目录。Taglets 允许您让 PHPDoctor 处理新的标签并更改现有标签及其输出的行为。
• default_package - 如果解析的代码未使用 package 标签或不是所有元素都有 package 标签，请使用此设置将未绑定的元素放入特定的包中。
• overview - 指定包含概述文档文本的 HTML 文件名，该文本将放置在概述页上。路径是相对于 "source_path"，除非给出了绝对路径。
• package_comment_dir - 在解析包中的第一个源文件所在的目录或给定目录中查找名为 package.html 的文件作为包注释。
• globals - 解析全局变量。
• constants - 解析全局常量。
• private - 为所有类成员生成文档。
• protected - 为公共和保护类成员生成文档。
• public - 仅针对公共类成员生成文档。

以下是为标准 doclet 定义的特定指令：

• d - 放置生成文档的目录。如果给定的路径是相对的，则相对于 "source_path"。
• windowtitle - 指定放置在 HTML <title> 标签中的标题。
• doctitle - 指定放置在概述摘要文件顶部的标题。
• header - 指定放置在每个输出文件顶部的页眉文本。页眉将放置在上方导航栏的右侧。
• footer - 指定放置在每个输出文件底部的页脚文本。页脚将放置在下方导航栏的右侧。
• bottom - 指定放置在每个输出文件底部的文本。文本将放置在页面底部，下方导航栏之下。
• tree - 创建类树。

3. 项目 API 使用文档

PHPDoctor 支持以下标签在文档注释中使用：

• @author name-text - 作者姓名。
• @deprecated deprecated-text - 废弃文本。
• {@link package.class#member label} - 链接到类成员。
• {@linkplain package.class#member label} - 链接到类成员（无下划线）。
• @param parameter-type parameter-name description - 参数描述。
• @return return-type description - 返回类型描述。
• @see package.class#member - 查看类成员。
• @since since-text - 自版本描述。
• @var var-type - 变量类型。
• @version version-text - 版本文本。

一些 Javadoc 标签对 PHP 不适用，其他标签由于 PHP 的松散类型而有所添加或略微更改。

4. 项目安装方式

请参考上述 "安装指南" 部分进行项目安装。