How to extract Doc Comments from PHP scripts which are not using classes?

Question

I am aware of PHP ReflectionClass to get doc comments from PHP scripts. Now I have come across these hundreds of old PHP scripts that are not using classes but only simple public functions. If I am right, ReflectionClass cannot be used here? My goal is to extract each doc comments. E.g. test1.php contains the following lines:

<?php
/**
 * some main comments here
 */
...some php lines here...

/**
 * function comment
 * Blah blah
 */
function foo()
{
 ...some php lines here...
}
...and more functions below each with comments

?>

So my desired ouput would be a table like:

--------------------------------------------------
| Filename  | FUNCTION | Comment                 |
--------------------------------------------------
| test1.php |          | some main comments here |
| test1.php | foo()    | function comment        |
|           |          | Blah Blah               |

Muescha, thanks. Not yet. I would appreciate if you can hint me further :) — tatskie
– tatskie, Commented Mar 25, 2017 at 0:22

Mihai Matei · Accepted Answer · 2017-03-24 14:28:44Z

1

You can use ReflectionFunction

$functions = get_defined_functions();

foreach ($functions['user'] as $function) {

    $reflection = new ReflectionFunction($function);

    var_dump($reflection->getName());
    var_dump($reflection->getDocComment());
}

The result would be (in case you have only the foo function defined):

string(3) "foo"
string(43) "/**
 * function comment
 * Blah blah
 */"

answered Mar 24, 2017 at 14:28

Mihai Matei

24.3k5 gold badges34 silver badges50 bronze badges

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

3 Comments

tatskie Over a year ago

Matei, How or where to specify the file test1.php? In my case, I will have hundreds of them say test1.php to test100.php. How does ReflectionFunction know which PHP file it's currently working on? Pardon me, there is not much documentation I can google around.

tatskie Over a year ago

Matei, also, what about the comment "some main comments here" at the start of test1.php? There are comments similar to this every start of a PHP file.

tatskie Over a year ago

I have to mark your answer correct and have to give credits also to Joachim from stackoverflow.com/questions/2197851/function-list-of-php-file.

Collectives™ on Stack Overflow

How to extract Doc Comments from PHP scripts which are not using classes?

1 Answer 1

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related