3

我有一组类,每个类都在自己的文件中。我添加了适当的 DocBlocks,以便在构建文档时不会收到错误或警告。这是一个非常简化的示例:

<?php
/**
 * Page level description.
 */

/**
 * Short class description.
 *
 * Longer description on what this class is all about.
 */
class Test {
    // a bunch of code
}
?>

当我在此类上运行 phpdoc 时,页面级 DocBlock 不会出现在生成的 HTML 中的任何位置。

原因可能是因为 2.0 版仍处于 Alpha 阶段。如果事实上我错过了什么,有人可以告诉我我错过了什么吗?

顺便说一句,我确实在试图找到答案方面做了功课。我在 2 个月前发现了这篇文章,但它引用了 phpDocumentor 的早期版本,并且看起来 OP 并没有指定它是否令人满意地回答了这个问题。

4

1 回答 1

1

[...] 如果页面级 DocBlock 包含 @package 标记,则它是文件中的第一个 DocBlock。[...]

<?php
/**
 * Page-level DocBlock
 * @package pagepackage
 */
/**
 * Define DocBlock
 */
define("ahhhh","Now the Page-level DocBlock is for the page, and the Define DocBlock for the define");
?>

参考: http: //manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_elements.pkg.html

于 2013-04-23T08:29:53.050 回答