代码审计以及代码文档插件的安装和使用

phpstorm里面内置了2种工具: 代码审计插件和代码文档输出插件.
代码审计目前包括: 代码重复性检测, 可能存在的Bug, 未达最佳标准的代码；过于复杂的语法, 从未使用过的参数、方法、属性等等.

代码审计

首先推荐下phpstorm里面自带的php代码审计工具

配置方法如下图:

php下面的那些选项可以检测并显示代码中的重复代码, 变量声明未启用, 未声明等. 举几个栗子:

• action方法重复定义
  

• 变量未声明(灰色的配色提示)
  

• 变量未定义
  

另外推荐https://phpmd.org/ 这个代码审核工具.

• 安装方法如下

$ wget -c http://static.phpmd.org/php/latest/phpmd.phar
$ chmod +x phpmd.phar
$ mv phpmd.phar /usr/local/bin/phpmd

• 如何集成到phpstorm里面去? 往下看:

进入 preferences->language & framework->php->Mess detector 之后,如下图:

然后点击configuration后面的 ... 弹窗如下:

然后将路径写入, 点击按钮, 然后 Apply, 安装完毕.

• 安装完毕之后就是配置了. 如下图:
  
  按照如此配置即可. 此外在php这个小项下面还有好几个都有代码审计工具, 可以按照默认情况不修改即可.
• 如果代码编写的不合规范的话, phpstorm会在右侧标黄显示, 点击会给出修改意见. 如下:
  

再推荐一个静态扫描工具phplint

这个工具会扫描出类似如下代码的warning.

if($var=1){
    echo 'i am here';
}

安装方法:

wget http://www.icosaedro.it/phplint/phplint-3.0_20160307.tar.gz
tar –xvf phplint-3.0_20160307.tar.gz
chmod +x phplint-3.0_20160307/phpl
sudo mv phplint-3.0_20160307/phpl /usr/local/bin/phpl
//产出结果报告
find ./ -name "*.php" -type f -exec phpl {} ; > report.txt

代码文档phpdoc的使用

为了提高前后端分离的沟通效率, 我们可以使用统一格式的代码注释风格进而自动化生成接口文档供前后端接口对接.

• phpdoc的注释规范可以看这里
• 在代码处使用快捷键: command+n, 呼出界面:
  
• 点击PHPDOC Blocks, 然后界面如下:
  
  选择你想自动生成代码注释的函数或者类, 点"ok"即可自动生成.
• 如果函数的参数变化了, 定位到函数名处, alt+enter即可更新phpdoc注释.

导出代码文档

• 首先需要安装pear, 安装方法自动百度
• 然后安装phpdocument.

pear install phpdoc/phpdocumentor
brew install graphviz

• 导出文档(--template 参数可以选择不同的模板进行导出. 其他参数phpdoc -h自己看)

phpdoc --directory=Apps/Merchant --target=docs/ --template="responsive"

然后直接进去docs文件夹内点击index.html即可打开文档主页, 是下面这个样子:

然后你想去看什么类的文档自己去看即可.

• 如果你想导出markdown格式的文档的话, 执行如下命令:

//安装phpdoc2php
下载这个文件到本地 http://pan.baidu.com/s/1nvKZDix
$ chmod +x phpdoc2md.php
$ mv phpdoc2md.php /usr/local/bin/phpdoc2php
//导出文档的xml格式
$ phpdoc --directory=Apps/Merchant --target=docs/ --template="xml"
//转化为md格式
phpdoc2php docs/structure.xml md_outdir