PHPMD 技术文档

1. 安装指南

PHPMD 的安装可以通过以下几种方式完成：

使用 Phar 包

你可以从 PHPMD 官网 下载最新稳定版本的 Phar 包。下载后，可以使用以下命令运行：

$ wget -c https://phpmd.org/static/latest/phpmd.phar
$ chmod +x phpmd.phar
$ ./phpmd.phar

使用 Composer

如果你使用 Composer 管理项目依赖，可以在项目的 composer.json 文件中添加以下内容：

{
    "require-dev": {
        "phpmd/phpmd": "^2.15"
    }
}

然后运行以下命令安装 PHPMD：

$ composer install

2. 项目使用说明

PHPMD 可以通过命令行界面（CLI）使用。基本的使用方法如下：

$ phpmd [filename|directory[,filename|directory[,...]]] [report format] [ruleset file]

例如：

$ phpmd php/PDepend/DbusUI/ xml rulesets.xml

在这里，php/PDepend/DbusUI/ 是要分析的源代码路径，xml 是输出格式，而 rulesets.xml 是规则集文件。

3. 项目 API 使用文档

PHPMD 的 API 文档可以在其官方网站上找到。目前，PHPMD 提供了以下渲染器：

• xml：以 XML 格式输出报告。
• text：简单的文本格式输出。

你可以在命令行中使用这些渲染器，例如：

$ phpmd php/PDepend/DbusUI/ xml codesize

4. 项目安装方式

PHPMD 的安装方式已经在“安装指南”部分详细介绍。以下是简要总结：

• 下载并运行 Phar 包。
• 使用 Composer 安装。

确保遵循上述指南，以便正确安装和配置 PHPMD。