PHPMD - PHP Mess Detector

等价于java工具PMD，能够对php 源代码进行如下问题检测：

  • 可能的bug
  • 欠佳的代码
  • 过于复杂的表达式
  • 未使用的方法、变量、参数、属性

官方文档 : https://phpmd.org/about.html

通过composer 安装 , 随便找个目录 就可以 不需要放在你的项目中.

Installing via Composer

创建 composer.json 文件

{
    "require-dev": {
        "phpmd/phpmd" : "@stable"
    }
}

安装composer

curl -s http://getcomposer.org/installer | php

安装 phpmd

php composer.phar install

安装完 你就可以 进入 bin , 找到 phpmd 可执行文件

cd ./vendor/phpmd/phpmd/src/bin

开始实操 :

./phpmd  /script/src/Controller/Admin ansi cleancode

基本使用

phpmd /path/to/source text codesize

  • 第一个参数 要检测的代码地址
  • 第二个参数指定输出检测结果的格式
  • 第三个参数是指定的规则集

规则集合

  • Clean Code: 一些包含clean code的规则集合，包括面向对象设计的 SOLID（单一功能、开闭原则、里氏替换、接口隔离以及依赖反转）原则。
  • Code Size : 有关代码大小的相关问题，例如行数等
  • Controversial : 具有争议的规则，可以不参考此规则
  • Design ： 设计规则，包含类依赖数量等等
  • Naming: 命名规则
  • Unused Code: 未使用代码规则