Question

我想获取方法的注释，例如采用以下方法：

/**
* Returns the regex to extract all inputs from a file.
* @param string The class name to search for.
* @return string The regex.
*/
public function method($param)
{
  //...
}

结果应该是

Returns the regex to extract all inputs from a file.
@param string The class name to search for.
@return string The regex.

我找到的方法是使用像file_get_content这样的函数来获取文件内容 - ＆gt;过滤我想要的方法 - ＆gt;获取评论使用regexp

看起来有点复杂，有没有方便的存档方式？

Answer 1

如果你想在PHP中使用注释来查看php reflection api中的getDocComment

Answer 2

PHP Doc。像Java Doc。

Answer 3

实际上你可以用getDocComment

获得方法的doc评论

$ref=new ReflectionMethod('className', 'methodName');

echo $ref->getDocComment();

Answer 4

对于方法转储，我使用我编写的这个小函数。它从提供的类中获取所有公共的方法（因此对你有用）。

我个人使用dump（）方法很好地格式化输出的方法名称和描述数组，但如果您希望将其用于其他内容，则不需要： - ）

function getDocumentation($inspectclass) {
    /** Get a list of all methods */
    $methods = get_class_methods($inspectclass);
    /** Get the class name */
    $class =get_class($inspectclass);
    $arr = [];
    foreach($methods as $method) {
        $ref=new ReflectionMethod( $class, $method);
        /** No use getting private methods */
        if($ref->isPublic()) {
            $arr[$method] = $ref->getDocComment();
        }
    }
    /** dump is a formatting function I use, feel free to use your own */
    return dump($arr);
}
echo getDocumentation($this);

获取php方法评论

4 个答案: