【发布时间】:2011-06-13 04:21:08
【问题描述】:
我尝试在每个PHP文件中写评论,然后评论将由Doxygen生成,有谁知道如何编写评论头PHP文件?
【问题讨论】:
-
您能否详细说明您的问题?
-
我想知道如何使用Doxygen编写文档程序,我从文件头开始,但我不知道如何正确编写头文件,谢谢!
我尝试在每个PHP文件中写评论,然后评论将由Doxygen生成,有谁知道如何编写评论头PHP文件?
【问题讨论】:
使用您最喜欢的 $searchengine 查找“php doxygen 教程”。我发现http://www.doxygen.nl/manual/docblocks.html#specialblock 很有帮助。
对于 PHP,您可能还想查看 phpDocumentor 或 docblox。
通常,PHP 文件中的 docblock 标头如下所示:
<?php
/**
* This is the file description
*
* @author Christian Weiske <cweiske@cweiske.de>
*/
...
我建议阅读phpDoc quickstart tutorial。注意 doxygen 支持 phpdoc 语法。
【讨论】: