我认为PHP_Codesniffer
可以指示何时没有 docblock - 请参阅此页面上的报告示例 (引用其中之一):
--------------------------------------------------------------------------------
FOUND 5 ERROR(S) AND 1 WARNING(S) AFFECTING 5 LINE(S)
--------------------------------------------------------------------------------
2 | ERROR | Missing file doc comment
20 | ERROR | PHP keywords must be lowercase; expected "false" but found
| | "FALSE"
47 | ERROR | Line not indented correctly; expected 4 spaces but found 1
47 | WARNING | Equals sign not aligned with surrounding assignments
51 | ERROR | Missing function doc comment
88 | ERROR | Line not indented correctly; expected 9 spaces but found 6
--------------------------------------------------------------------------------
我想您可以使用 PHP_Codesniffer 至少获取所有没有文档的文件/类/方法的列表;据我记得,它可以生成 XML 作为输出,使用一些自动化工具更容易解析——这可能是一些 docblock-generator 的第一步;-)
另外,如果您使用phpDocumentor生成文档,这个可以不报告丢失块的错误吗?
经过几次测试后,它可以——例如,在没有太多文档的类文件上运行它,并带有如下--undocumentedelements
选项:
phpdoc --filename MyClass.php --target doc --undocumentedelements
在输出中间给出这个:
Reading file /home/squale/developpement/tests/temp/test-phpdoc/MyClass.php -- Parsing file
WARNING in MyClass.php on line 2: Class "MyClass" has no Class-level DocBlock.
WARNING in MyClass.php on line 2: no @package tag was used in a DocBlock for class MyClass
WARNING in MyClass.php on line 5: Method "__construct" has no method-level DocBlock.
WARNING in MyClass.php on line 16: File "/home/squale/developpement/tests/temp/test-phpdoc/MyClass.php" has no page-level DocBlock, use @package in the first DocBlock to create one
done
但是,在这里,即使它作为报告工具很有用,在生成丢失的文档块时也没有那么有用......
现在,我不知道有什么工具可以为您预先生成丢失的文档块:我通常在我的持续集成机制中使用 PHP_Codesniffer 和/或 phpDocumentor,它会报告丢失的文档块,然后,每个开发人员都会添加缺少的内容,从他的 IDE...
...效果很好:通常每天丢失的文档块不超过几个,因此可以手动完成任务(并且 Eclipse PDT 提供了一个功能来为方法预生成文档块,当您编辑特定文件/方法)。
Appart 从那,我真的不知道任何全自动工具来生成 docblocks ......但我很确定我们可以设法创建一个有趣的工具,使用:
不过,经过一番搜索,我找到了这篇博文(它是法语的——也许这里的一些人能够理解):Ajout automatique de Tags phpDoc à l'aide de PHP_Beautifier。
可能的标题翻译:“使用 PHP_Beautifier 自动添加 phpDoc 标签”
这个想法实际上还不错:
我链接到的博客文章中使用的想法是:
- 创建一个新的 PHP_Beautifier 过滤器,它将检测以下标记:
T_CLASS
T_FUNCTION
T_INTERFACE
- 并在它们之前添加一个“草稿”文档块,如果还没有的话
要在某个文件上运行该工具MyClass.php
,我必须先安装PHP_Beautifier
:
pear install --alldeps Php_Beautifier-beta
然后,将过滤器下载到我正在工作的目录(当然可以将它放在默认目录中):
wget http://fxnion.free.fr/downloads/phpDoc.filter.phpcs
cp phpDoc.filter.phpcs phpDoc.filter.php
并且,在那之后,我创建了一个新beautifier-1.php
脚本(基于我链接到的博客文章中的建议,再次),它将:
- 加载我的
MyClass.php
文件的内容
- 实例化
PHP_Beautifier
- 添加一些过滤器来美化代码
- 添加
phpDoc
我们刚刚下载的过滤器
- 美化我们文件的源代码,并将其回显到标准输出。
脚本的代码beautifier-1.php
将是这样的:(
再一次,最大的部分是从博客文章中复制粘贴;我只翻译了评论,并更改了一些小东西)
require_once 'PHP/Beautifier.php';
// Load the content of my source-file, with missing docblocks
$sourcecode = file_get_contents('MyClass.php');
$oToken = new PHP_Beautifier();
// The phpDoc.filter.php file is not in the default directory,
// but in the "current" one => we need to add it to the list of
// directories that PHP_Beautifier will search in for filters
$oToken->addFilterDirectory(dirname(__FILE__));
// Adding some nice filters, to format the code
$oToken->addFilter('ArrayNested');
$oToken->addFilter('Lowercase');
$oToken->addFilter('IndentStyles', array('style'=>'k&r'));
// Adding the phpDoc filter, asking it to add a license
// at the beginning of the file
$oToken->addFilter('phpDoc', array('license'=>'php'));
// The code is in $sourceCode
// We could also have used the setInputFile method,
// instead of having the code in a variable
$oToken->setInputString($sourcecode);
$oToken->process();
// And here we get the result, all clean !
echo $oToken->get();
请注意,我还必须在路径中添加两个小东西phpDoc.filter.php
,以避免出现警告和通知...
相应的补丁可以在那里下载:http://extern.pascal-martin.fr/so/phpDoc.filter-pmn。修补
现在,如果我们运行该beautifier-1.php
脚本:
$ php ./beautifier-1.php
使用MyClass.php
最初包含此代码的文件:
class MyClass {
public function __construct($myString, $myInt) {
//
}
/**
* Method with some comment
* @param array $params blah blah
*/
public function doSomething(array $params = array()) {
// ...
}
protected $_myVar;
}
这是我们得到的结果——一旦我们的文件被 Beautified :
<?php
/**
*
* PHP version 5
*
* LICENSE: This source file is subject to version 3.0 of the PHP license
* that is available through the world-wide-web at the following URI:
* http://www.php.net/license/3_0.txt. If you did not receive a copy of
* the PHP License and are unable to obtain it through the web, please
* send a note to license@php.net so we can mail you a copy immediately.
* @category PHP
* @package
* @subpackage Filter
* @author FirstName LastName <mail>
* @copyright 2009 FirstName LastName
* @link
* @license http://www.php.net/license/3_0.txt PHP License 3.0
* @version CVS: $Id:$
*/
/**
* @todo Description of class MyClass
* @author
* @version
* @package
* @subpackage
* @category
* @link
*/
class MyClass {
/**
* @todo Description of function __construct
* @param $myString
* @param $myInt
* @return
*/
public function __construct($myString, $myInt) {
//
}
/**
* Method with some comment
* @param array $params blah blah
*/
public function doSomething(array $params = array()) {
// ...
}
protected $_myVar;
}
我们可以注意到:
- 文件开头的许可证块
- 已添加到
MyClass
类的 docblock
__construct
在方法中添加的 docblock
- 上的文档块
doSomething
已经存在于我们的代码中:它没有被删除。
- 有一些
@todo
标签^^
现在,它当然并不完美:
- 它也没有记录我们想要的所有东西
- 例如,在这里,它没有记录
protected $_myVar
- 它不会增强现有的文档块
- 它不会在任何图形编辑器中打开文件
但我很确定这个想法可以用作更有趣的事情的起点:
- 关于未记录的内容:添加将被识别的新标签应该不会太难
- 我不得不承认,增强现有的文档块可能更难
- 一件好事是这可以是全自动的
- 使用 Eclipse PDT,也许这可以设置为External Tool,所以我们至少可以从我们的 IDE 启动它?