4

Doxygen を使用してクラス属性を文書化しようとしています。現在、保護された属性は、特定のクラスのページの上部にあるリストに表示されます。それらについて説明を加えたいと思います。

@param [name] [description]クラスの先頭と属性の宣言のすぐ上の両方を使用してみました。コンストラクタークラスの docblock にそれらを入れようとしたところ、壊れてしまいました。

私が見逃しているものはありますか?

-- ローガン

4

2 に答える 2

5

<属性の直前に使用またはコメントする必要があります。

class cMainData
{
    private $attr;  //!< This is my attribute

    //! This is another attribute
    private $otherAttr;
}

@brief、@note などを使用できることに注意してください。

class cMainData
{
    private $attr;  //!<@brief This is my attribute.
                    //!< This is some additional info about this attribute.
}
于 2010-12-02T16:24:51.257 に答える
1

この質問の複製に対する回答として回避策を投稿しました: Doxygen: how to describe class member variables in php? phpDoc アノテーション スタイルと互換性のあるソリューションを必要とする他のユーザーのために、ここからリンクすると便利な場合があります。

于 2011-12-12T18:03:32.400 に答える