php - phpDoc を使用すると、エラーは発生しませんが、結果も得られません

Question

次のようないくつかのファイルを使用します。

/**
 * 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 を実行します。結果ページにはエラーは表示されませんが、ファイル、パッケージ、またはクラスへのリンクも表示されません。

何か案は？

スクリーンショット:

Answer 1

ファイル自体が User パッケージの一部として表示されないのは奇妙です。ドキュメント化可能な要素（クラス、関数、定数）も含まれている場合にのみ、ファイルがパッケージリストに参加するようにphpdoc2が動作しているのではないかと思います。ファイルが手続き型コードのみの場合、ドキュメント化可能な要素はおそらく存在しないため、phpdoc2 はドキュメント化するものがないと判断します。

実験として、実際にファイルに文書化可能な要素が含まれていない場合は、それを User パッケージに入れるクラスレベルの docblock を含む空のクラス宣言を追加してみてください。これにより、クラスとファイルの両方がユーザー パッケージ リストに表示されるようになるかどうかを確認したいと思います。