Doxygenを使用してクラス属性をどのように文書化しますか?
-
29-09-2019 - |
質問
Doxygenを使用してクラス属性を文書化しようとしています。現在、保護された属性は、特定のクラスのページ上部にあるリストに表示されます。説明をしたいのですが。
使ってみました @param [name] [description]
クラスの始まりの上で、属性の宣言のすぐ上。コンストラクタークラスのためにそれらをドックブロックに入れてみましたが、それを壊しました。
私が足りないものはありますか?
- ローガン
解決
使用する必要があります <
または、属性の直前にコメントします。
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.
}
他のヒント
この質問の複製に対する回答として回避策を投稿しました。 Doxygen:PHPのクラスメンバー変数を説明する方法は? PHPDOCアノテーションスタイルと互換性のあるソリューションが必要な他の人のために、ここからリンクすると便利かもしれません。
所属していません StackOverflow