JAVADOC
Javaで、Javadocと言われる、プログラムについて説明するドキュメントをソースコードに埋め込むための方法がある。
利点：
プログラムについての説明をソースコードに埋め込むことにより、プログラムの説明を別ファイルで管理する必要性をなくす事が可能。
ソースコード修正時に、ドキュメントの修正も出来るため、ソースとドキュメントの不一致の防止が可能。
code:c
/// フリーズデータ ヘッダ部 構造体の定義
typedef struct {
UCHAR ucStoreNum; ///<ストア番号
UCHAR ucDatExist; ///<データ有/無
UCHAR ucPrdCode2; ///<コード ULONG ulPrdNum; ///<番号
} FRZ_HEAD;
これなら、構造体の抽出時に、
FRZ_HEAD フリーズデータ ヘッダ部 構造体の定義
という形で表示出来る。
code:c
/** フリーズデータ ヘッダ部 構造体の定義 ************************* */
typedef struct {
UCHAR ucStoreNum; ///<ストア番号
UCHAR ucDatExist; ///<データ有/無
UCHAR ucPrdCode2; ///<機種コード("H") ULONG ulPrdNum; ///<機種番号
} FRZ_HEAD;
これだと、
FRZ_HEAD
のみで、説明が表示されない。
/** */で囲まれている所は、
フィールド詳解
に記載される。
コマンド
タグ
table:mdtag
mainpage
table:doxytag
@file ファイルの説明を記述します。
@author プログラムやドキュメントの著者を記述します。
@version バージョン情報を記述します。
@since 関連する機能やバージョンが導入された時期を記述します。
@param メソッドのパラメータに関する説明を記述します。
@return メソッドが返す値に関する説明を記述します。
@throws メソッドがスローする例外に関する説明を記述します。
table:doxytag
@file ファイルの説明を記述します。
@author プログラムやドキュメントの著者を記述します。
@version バージョン情報を記述します。
@since 関連する機能やバージョンが導入された時期を記述します。
@param メソッドのパラメータに関する説明を記述します。
@return メソッドが返す値に関する説明を記述します。
@throws メソッドがスローする例外に関する説明を記述します。
@deprecated 非推奨となったメソッドやクラスに関する情報を記述します。
@see 他のクラスやメソッドへの参照を記述します。
@link リンクを生成して、他のクラスやメソッドに参照を作成します。
@inheritDoc スーパークラスまたはインターフェースからのドキュメントを継承します。
@code コードブロック内のテキストをコードとして表示します。
@literal リテラルなテキストをそのまま表示します。
@implSpec インターフェースや抽象クラスの実装に関する仕様を記述します。
@apiNote API設計者が提供する追加情報を提供します。
@docRoot ドキュメントルートのパスを示します。
@serial シリアルバージョンUIDを記述します。
@serialField シリアライズ可能なフィールドの説明を記述します。
@serialData シリアル化されたデータの説明を記述します。
@serialVersionUID シリアルバージョンUIDを指定します。
code:docxygen
タグ・オプションの使用
Xaoptcmf引数を使用して、ソース・コード内のタグを配置できる位置と、Xを使ってこのタグを無効にできるかどうかを特定します。
タグの配置
タグの配置位置を制限しない場合はaを指定します。それ以外の文字の組み合わせも可能です。
X (タグの無効化)
a (すべて)
o (概要)
p (パッケージ)
t (型すなわちクラスおよびインタフェース)
c (コンストラクタ)
m (メソッド)
f (フィールド)
s (モジュール)
https://gyazo.com/5d618795a420a8584425c2723525121f