2011-10-28 7 views
7

私のC++コードにtypedef構造体があります。今のところ、彼らは\var typedefとしてリストされています。これを行うより良い方法はありますか?Doxygenでtypedefをどのように分類すればよいですか?

/*! \var typedef etc 
* \brief A type defined structure for etc 
* 
* \param x type- Variable declaration for x 
* \param y type- Variable declaration for y 
*/ 

私は、私もparamを言っべきではありません知っている:以下は私が持っているものの一例です。それ以外に何がありますか?

+1

なぜ 'typedef'ですか?これはC++ではなく、Cです。 – Pubby

+5

@ Pubby8: 'typedef'はコードの読みやすさを向上させるためにC++で引き続き使用されています。 'typedef'の一般的な使い方は、関数へのポインタを作成することです。もう一つはテンプレートです。 –

+2

@ThomasMatthews私はそのようにtypedefを使うことは理解できますが、なぜ 'struct'の代わりに' typedef struct'を使うのでしょうか? – Pubby

答えて

10

Doxygen documentationによれば、\typedefコマンドがあります。コマンドは\varコマンドと同じように動作します。

21

typedefの前にコメントブロックを置くと、特別なコマンドを使う必要はありません。

/** This is the documentation for the following typedef */ 
typedef MyClass MyTypedef; 

は、次のような使用のtypedef後にそれを置くことを好む場合は、次のコメントブロックは、実際のtypedefとは異なる場所でなければならないとき

typedef MyClass MyTypedef; 
/**< This is the documentation for the preceding typedef */ 

のみ、あなたは\ typedefを使用する必要があります。

関連する問題