HeaderDoc C++ Tag set |
|||||||||||||||||
|
|
はじめにHeaderDoc はそれがＣヘッダーをする同じ方法で多くで C++ ヘッダーを処理します。 実際、 HeaderDoc が C++ ヘッダーでクラス宣言に遭遇するまで、処理は同一です。 これはあなたが C++ ヘッダーの中でＣヘッダーのために定義されたタグのどれでも使うことができることを意味します HeaderDoc_C_TagSetを見てください。例えば、２つのクラスを宣言するヘッダーで、あなたはなぜこれらのクラスが、なぜまとめられるかを説明して論議するのに@header タグを使うこと使い、そしてそれぞれのクラスを論議するために @class タグが使えます. HeaderDoc が C++ ヘッダーで @class タグ（クラス宣言に伴う）に遭遇すると、そこからクラス宣言の終わりまでのすべてのコメントと次に続く宣言を、ヘッダーファイルではなく、そのクラスに属しているとコメントやタグと見なします。 HeaderDoc が C++ ヘッダーのために HTML ドキュメンテーションを生み出すとき、それはヘッダーの中で宣言されたそれぞれのクラスとヘッダーのためにフレームセットを作成します． HeaderDoc は C++ クラスの中で宣言された API 要素のアクセス制限レベル（パブリック、プロテクティッド、あるいはプライベート）を記録してます このインフォメーションは結果として生じているドキュメンテーションで API 要素をまとめるために使われます。 C++ クラス宣言の中で、 HeaderDoc は以下の追加のタグを受け付けます． この文書のお約束タグはそれぞれのタイプに依存して、１つか２つの追加情報を提供するフィールドがあります． @method [メソッド名] @param [パラメーター名] [パラメータについての説明...] 以下の表での"フィールド数"の行の番号はそのタグがいくつのフィールドをとるかを示しています． 注意）赤く書かれたタグは必須タグです C++クラス宣言のための追加のタグC++ クラス宣言の中で、 HeaderDocはＣヘッダーのために、次のセクションでリストされる若干の新しいタグとともに言語タグのすべてのタグを理解しますクラスタグ(@class)
@classタグに後に、あなたはクラスの目的についての概要を書く事が出来ます． @abstractタグや@discussionタグを使ってソースコードを概要とより深い議論に分けたり、以下の例で示すようにタグのない単純なコメントを書く事も出来ます． 例１ - @abstractと@discussionでタグつけられたコメント:
/*!
@class IOCommandGate
@abstract Single-threaded work-loop client request mechanism.
@discussion An IOCommandGate instance is an extremely light weight
mechanism that executes an action on the driver's work-loop...
*/
class IOCommandGate : public IOEventSource
{
...
}
例２ - シングルブロックコメント:
/*!
@class IOCommandGate
A class that defines a single-threaded work-loop client
request mechanism. An IOCommandGate instance is an extremely
light weight mechanism that executes an action on the
driver's work-loop...
*/
class IOCommandGate : public IOEventSource
{
...
}
関数タグ(@function)メンバ関数のためのタグです．そのまま、@functionタグを使って下さい．詳しくはHeaderDoc_C_TagSetを見てください変数タグ(@var)メンバーデータのために、あなたはタグを付けることのために２つの選択を持っています。C言語のタグと同じ型固有のタグで記述するか、型に依存しない@varタグを使う事が出来ます．
例
/*! @var we_are_root TRUE if this device is the root power domain */
bool we_are_root;
一般に型が特定できるタグを使う方がいいです．タグがHeaderDocにコメントの後に続く宣言文をどのように処理すべきかのヒントが与えられます．(すべての型にタグがある訳ではないですが...) 例えば@strauctタグは，処理すべき宣言がセミコロンで終わる複数の行が波括弧で囲まれている事を知っています． もし同じデータメンバに@varとタグ付けしていたならばHeaderDocは最初のセミコロンの後に宣言を処理するのをやめてしまうかもしれません．(上記のwe_are_rootの型宣言では適切なんです．) @varタグはintやfloatやdouble等の単純な型に適切なのです． |
||||||||||||||||
|
|||||||||||||||||