使用 phpDoc，我没有收到任何错误，但也没有结果答案

【问题标题】：Using phpDoc, I get no errors, but no results either使用 phpDoc，我没有收到任何错误，但也没有结果
【发布时间】：2012-05-16 21:59:45
【问题描述】：

有几个这样的文件：

/**
 * Creates a new user account.
 * Collects posted form variables, escapes them, then passes them on to Storm.
 * @package User
 */

/**
 * Do includes.
 */
include_once('../Utilities.php');
include_once('../stormLibs/user.php');

...等等。

然后我从 phpdoc.org 运行 phpDocumentor 2。结果页面没有显示任何错误，但也没有指向任何文件、包或类的链接。

有什么想法吗？

截图：

【问题讨论】：

请注意，/** * Do includes. */ 是无用的评论，因此比根本没有评论还要糟糕。评论应该描述为什么或如何你正在做某事，而不仅仅是重申什么你正在做。
关键是要在生成的文档中显示一些内容。有什么想法吗？
@ChrisKohout：phpDoc cmets 用于 cmets 类、类成员、方法和独立函数。他们不记录任何其他内容。它们需要附加到上述令牌之一。

标签： php phpdoc

【解决方案1】：

奇怪的是，您甚至没有将文件本身列为用户包的一部分。我想知道 phpdoc2 的行为是否使得一个文件只加入一个包列表，如果它还包含一些可记录的元素（类、函数、常量）。如果您的文件只是程序代码，则其中可能没有可记录的元素，因此 phpdoc2 认为它没有什么可记录的。

作为一个实验，如果您的文件中确实没有可记录的元素，请尝试添加一个空的类声明，其中包含一个将其放入 User 包中的类级文档块。我很想看看这是否会使类和文件都出现在用户包列表中。

【讨论】：