3

コメントで宣言および説明する多くの変数を持つオブジェクトがあります。phpDoc を使用して後で処理するために非常に徹底的にコメントしていますが、実際にドキュメントをコンパイルした経験はまだありません。

phpDoc 表記では、設定したい唯一の属性が説明である場合でも、各変数が 4 ～ 6 行のコードを消費するのは非常に面倒です。

/**
 * @desc this is the description
 */

 var $variable = null;

次の表記法を使用したいと思います。

# @desc this is the description
var $variable = null;

これを受け入れるようにphpDocを微調整する簡単な方法はありますか、それとも実際にドキュメントをコンパイルしようとすると問題が発生しますか? 今は微調整は必要ありません (もちろんありがたいのですが)、コードの大部分を再設計することなくこれが実現可能かどうか、phpDoc を知っている誰かからの声明です。

4

2 に答える 2

12

1行のdocblockを書くだけ

/** @desc this is the description */
var $variable = null;

問題が解決しました。

于 2009-11-04T01:53:07.250 に答える
2

フランク・ファーマーが言及したことに加えて（彼の解決策に+1）、

/**T_DOC_COMMENTは、PHP 5 以降の PHP トークナイザーのように宣言されています。これは、ドキュメントの表記法がすべて から/**まで解析されることを意味します*/。

PHP ドキュメントをそのまま使用し#たり、作成したりすることはできません。/*

見る：

http://www.php.net/manual/en/tokens.php

于 2009-11-04T01:56:37.190 に答える