【问题标题】:How to write a comment header PHP file with Doxygen?如何用 Doxygen 编写注释头 PHP 文件?
【发布时间】:2011-06-13 04:21:08
【问题描述】:

我尝试在每个PHP文件中写评论,然后评论将由Doxygen生成,有谁知道如何编写评论头PHP文件?

【问题讨论】:

  • 您能否详细说明您的问题?
  • 我想知道如何使用Doxygen编写文档程序,我从文件头开始,但我不知道如何正确编写头文件,谢谢!

标签: php comments doxygen


【解决方案1】:

使用您最喜欢的 $searchengine 查找“php doxygen 教程”。我发现http://www.doxygen.nl/manual/docblocks.html#specialblock 很有帮助。

对于 PHP,您可能还想查看 phpDocumentordocblox

通常,PHP 文件中的 docblock 标头如下所示:

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

我建议阅读phpDoc quickstart tutorial。注意 doxygen 支持 phpdoc 语法。

【讨论】:

  • 实际上,我需要一个包含 Doxygen 的文档,@author、@file、@section 已记录,但文件夹中的文件未记录,我对此感到困惑。
  • 讽刺的是,这个页面是上面查询的第一个结果:)
  • 这里也一样,@AndréLaszlo。谷歌把我带到了这里,这个答案是次优的。
猜你喜欢
  • 1970-01-01
  • 2023-03-12
  • 2015-07-05
  • 2016-12-01
  • 1970-01-01
  • 2012-03-26
  • 1970-01-01
  • 2015-03-19
  • 1970-01-01
相关资源
最近更新 更多