fetch php method comments

Question

I want to fetch a method's comments,take below method for example:

/**
* 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)
{
  //...
}

the result should be

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

the way I find is use a function like file_get_content to get file content -> filter the method I want -> fetch the comment use regexp

it seems a bit complicated , is there any convenient way to archive this?

Answer 1

actually you can get a method's doc comments with getDocComment

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

echo $ref->getDocComment();

Answer 2

If you want to use the comment in PHP for something check out getDocComment in php's reflection api