How to write a comment header PHP file with Doxygen?

Question

i trying to write a comment in each PHP file, then the comment will generated by Doxygen, does anyone know how to write a comment header PHP file?

Answer 1

Use your favorite $searchengine to look for "php doxygen tutorial". I found http://www.doxygen.nl/manual/docblocks.html#specialblock to be helpful.

For PHP, you might also want to look into phpDocumentor or docblox.

Generally, a docblock header in a PHP file looks like this:

<?php
/**
 * This is the file description
 *
 * @author Christian Weiske <cweiske@cweiske.de>
 */
...

I suggest reading the phpDoc quickstart tutorial. Note that doxygen supports the phpdoc syntax.