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 を実行すると、生成された HTML のどこにもページレベルの DocBlock が表示されません。

これはおそらく、バージョン 2.0 がまだアルファ版であるためです。実際に何かが欠けている場合、誰かが私が欠けているものについて教えてくれますか?

ところで、私は答えを見つけようとして宿題をしました。2 か月前のこの投稿を見つけましたが、以前のバージョンの phpDocumentor を参照しており、OP が質問に十分に回答したかどうかを指定したようには見えません。

4

1 に答える 1

1

[...] @package タグが含まれている場合、ページレベルの DocBlock はファイル内の最初の 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 に答える