如何扫描项目中的“@todo”源码注释

Question

有没有办法扫描代码库中的任何 TODO 并生成可以在标准网页上显示的列表。

例如

@todo 已弃用的函数删除.........（functions.php [第 12 行]）

这需要在本地WAMP服务器上工作。

Answer 1

在Windows平台上或者如果您想使用PHP本身，您可以使用...

function getTodos($path) {
   $todos = array();
   $items = glob(rtrim($path, '/') . '/*');

   foreach($items as $item) {

       if (is_file($item) AND pathinfo($item, PATHINFO_EXTENSION) == 'php') {
           $fileContents = file_get_contents($item);

           $tokens = token_get_all($fileContents);

           foreach($tokens as $type = $token) {
               if (($type == 'T_COMMENT' OR $type == 'T_ML_COMMENT')
                   AND preg_match_all('/^\s*(?P<todo>@todo.*?)\z/m', $token, $matches) {
                  $todos = array_merge($todos, $matches['todo']);
               }
           }

       } else if (is_dir($item)) {
           $todos = array_merge$($todos, getTodos($item));
           continue;
       }       

   }

   return $lines;
}

我没有测试过它，但理论上它应该可以工作。 :)

在 *nix 上，您可以使用 grep...

$ grep -r \b@todo\b ./

它并不完美（它会在字符串中找到它），但它应该足够好了。 :)

Answer 2

Phpdoc 可以根据代码库中的注释和方法生成 html 文件。它还会显示待办事项等。

http://www.phpdoc.org/

Answer 3

PHPStorm 能够提取所有待办事项文件，我在提交之前使用它，功能非常好，并且开箱即用。

它是免费的开源许可证，
http://www.jetbrains.com/phpstorm/

还有各种其他可用的许可证
http://www.jetbrains.com/phpstorm/buy/index.jsp

[我不隶属于 Jetbrains，只是一个喜欢使用它的开发人员]