Question

我有一组类，每个类都在自己的文件中。我添加了适当的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个月前找到了this post，但是它引用了早期版本的phpDocumentor，并且看起来不像OP指定它是否满意地回答了问题。

Answer 1

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

<?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

phpDocumentor 2.0页面级DocBlock - 它在哪里？

1 个答案: