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?

Reza · Accepted Answer · 2015-03-01 16:20:53Z

6

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

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

echo $ref->getDocComment();

answered Mar 1, 2015 at 16:20

Reza

9658 silver badges7 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

AaA Over a year ago

This is correct, however it would be nice if you have mentioned that doc comment should be wrapped in /** */ to be retrieved and then if there are multiple comments on a method only closest comment will be returned and also the returned string contains the comment stars too and a link to ReflectionClass::getDocComment for further reading.

AaA Over a year ago

Also note that, at the time of asking this question method you have mentioned wasn't exist.

rojoca · Accepted Answer · 2010-03-11 08:20:10Z

4

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

answered Mar 11, 2010 at 8:20

rojoca

11.2k4 gold badges47 silver badges47 bronze badges

1 Comment

limboy Over a year ago

after a deep look , it isn't what I need . getDocComment just fetch class's comment , not method's. so I write a small script to do this gist.github.com/329113

VDVLeon · Accepted Answer · 2010-03-11 08:04:50Z

1

PHP Doc. Like Java Doc.

answered Mar 11, 2010 at 8:04

VDVLeon

1,3802 gold badges15 silver badges27 bronze badges

Comments

Tschallacka · Accepted Answer · 2015-10-07 08:51:04Z

For a method dump I use this little function I composed. It fetches all methods from provided class that are public(and thus of use to you).

I personally use a dump() method to nicely format the outputted array of method names and descriptions, but that's not needed if you wish to use it for something else :-)

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);

Collectives™ on Stack Overflow

fetch php method comments

4 Answers 4

2 Comments

1 Comment

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

2 Comments

1 Comment

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related