@fn【関数・メソッド】・@property【プロパティ】・@typedef【型定義】・@var【変数・列挙子】
@showrefby【参照元の表示】・@hiderefby【参照元の非表示】・@showrefs【参照先の表示】・@hiderefs【参照先の非表示】
@fn【関数・メソッド】
@property【プロパティ】
@typedef【型定義】
@var【変数・列挙子】
メモ
- 関数・メソッド・プロパティ・型定義・変数・列挙子を記述
- 定義の直前では、通常は省略 (自動解析)
その他の位置に記述する場合、必須 (関数・メソッドは同名可の為、シグネチャを指定) - enum自体は、@enum【列挙型】を参照
- グローバルな定義を出力する場合、@file【ファイル情報】を記述
- 定義の直前では、通常は省略 (自動解析)
- 関連
- 外部リンク
構文
@fn 関数・メソッド 宣言
@property プロパティ 宣言
@typedef 型定義 宣言
@var 変数・列挙子 宣言
例：グローバル関数 @fn【関数・メソッド】
/// @file
/// @brief グローバル関数の概要
/// @details グローバル関数の詳細 (@@fn 省略)
/// @param [in] p 引数の説明
/// @return 戻り値の説明
int GlobalFuncA(int p) {
return p;
}
int GlobalFuncSameName(int p) {
return p;
}
/// @fn GlobalFuncSameName(int)
/// @brief グローバル関数(int)の概要 (同名関数あり)
/// @details グローバル関数(int)の詳細 (@@fn 必須：シグネチャ指定)
/// @param [in] p 引数の説明
/// @return 戻り値の説明
float GlobalFuncSameName(float p) {
return p;
}
/// @fn GlobalFuncSameName(float)
/// @brief グローバル関数(float)の概要 (同名関数あり)
/// @details グローバル関数(float)の詳細 (@@fn 必須：シグネチャ指定)
/// @param [in] p 引数の説明
/// @return 戻り値の説明
【HTML出力例】
◆ GlobalFuncA()
| int GlobalFuncA | ( | int | p | ) |
グローバル関数の概要
グローバル関数の詳細 (@fn 省略)
- 引数
[in] p 引数の説明
- 戻り値
- 戻り値の説明
～.cpp の nnn 行目に定義があります。
◆ GlobalFuncSameName() [1/2]
| float GlobalFuncSameName | ( | float | p | ) |
グローバル関数(float)の概要 (同名関数あり)
グローバル関数(float)の詳細 (@fn 必須：シグネチャ指定)
- 引数
[in] p 引数の説明
- 戻り値
- 戻り値の説明
～.cpp の nnn 行目に定義があります。
◆ GlobalFuncSameName() [2/2]
| int GlobalFuncSameName | ( | int | p | ) |
グローバル関数(int)の概要 (同名関数あり)
グローバル関数(int)の詳細 (@fn 必須：シグネチャ指定)
- 引数
[in] p 引数の説明
- 戻り値
- 戻り値の説明
～.cpp の nnn 行目に定義があります。
例：グローバル変数 @var【変数・列挙子】
/// @file
/// @brief グローバル変数Ａの概要
/// @details グローバル変数Ａの詳細 (@@var 省略)
int GlobalVarA;
int GlobalVarB; ///< グローバル変数Ｂの概要 (後置：@@var 省略)
int GlobalVarC;
/// @var GlobalVarC
/// @brief グローバル変数Ｃの概要
/// @details グローバル変数Ｃの詳細 (@@var 必須)
【HTML出力例】
◆ GlobalVarA
| int GlobalVarA |
グローバル変数Ａの概要
グローバル変数Ａの詳細 (@var 省略)
～.cpp の nnn 行目に定義があります。
◆ GlobalVarB
| int GlobalVarB |
グローバル変数Ｂの概要 (後置：@var 省略)
～.cpp の nnn 行目に定義があります。
◆ GlobalVarC
| int GlobalVarC |
グローバル変数Ｃの概要
グローバル変数Ｃの詳細 (@var 必須)
～.cpp の nnn 行目に定義があります。
例：メソッド・クラス変数 (@fn【関数・メソッド】・@var【変数・列挙子】)
/// @brief クラスの概要
/// @details クラスの詳細
class ClassFn
{
public:
int varA = 1; ///< 変数Ａの概要 (@@var 省略)
/** @brief 変数Ｂの概要 (@@var 省略) */ int varB = 2;
/// @brief 変数Ｃの概要 (@@var 省略)
int varC = 3;
int varD = 4;
/// @brief メソッドの概要
/// @details メソッドの詳細 (@@fn 省略)
/// @param [in] p 引数の説明
/// @return 戻り値の説明
int methodA(int p)
{
return p;
}
int methodB(int p)
{
return p;
}
};
/// @fn ClassFn::methodB(int)
/// @brief メソッドの概要
/// @details メソッドの詳細 (@@fn 必須)
/// @param [in] p 引数の説明
/// @return 戻り値の説明
/// @var ClassFn::varD
/// @brief 変数Ｄの概要
/// @details 変数Ｄの詳細 (@@var 必須)
【HTML出力例】
ClassFn クラス
クラスの概要 [詳解]
公開メンバ関数 | |
| int | methodA (int p) |
| メソッドの概要 | |
| int | methodB (int p) |
| メソッドの概要 | |
公開変数類 | |
| int | varA = 1 |
| 変数Ａの概要 (@var 省略) | |
| int | varB = 2 |
| 変数Ｂの概要 (@var 省略) | |
| int | varC = 3 |
| 変数Ｃの概要 (@var 省略) | |
| int | varD = 4 |
| 変数Ｄの概要 | |
詳解
クラスの概要
クラスの詳細
～.cpp の nnn 行目に定義があります。
関数詳解
◆ methodA()
| inline |
メソッドの概要
メソッドの詳細 (@fn 省略)
- 引数
[in] p 引数の説明
- 戻り値
- 戻り値の説明
～.cpp の nnn 行目に定義があります。
◆ methodB()
| inline |
メソッドの概要
メソッドの詳細 (@fn 必須)
- 引数
[in] p 引数の説明
- 戻り値
- 戻り値の説明
～.cpp の nnn 行目に定義があります。
メンバ詳解
◆ varA
| int ClassFn::varA = 1 |
変数Ａの概要 (@var 省略)
～.cpp の nnn 行目に定義があります。
◆ varB
| int ClassFn::varB = 2 |
変数Ｂの概要 (@var 省略)
～.cpp の nnn 行目に定義があります。
◆ varC
| int ClassFn::varC = 3 |
変数Ｃの概要 (@var 省略)
～.cpp の nnn 行目に定義があります。
◆ varD
| int ClassFn::varD = 4 |
変数Ｄの概要
変数Ｄの詳細 (@var 必須)
～.cpp の nnn 行目に定義があります。
例：@property【プロパティ】
// 【C#】
/// @brief クラスの概要
/// @details クラスの詳細
class ClassProperty
{
/// @brief プロパティＡの概要
/// @details プロパティＡの詳細 (@@property 省略)
public int PropertyA { get; set; }
public int PropertyB { get; set; }
/// @property PropertyB
/// @brief プロパティＢの概要
/// @details プロパティＢの詳細 (@@property 必須)
public int PropertyC { get; set; }
}
/// @property ClassProperty::PropertyC
/// @brief プロパティＣの概要
/// @details プロパティＣの詳細 (@@property 必須)
【HTML出力例：プロパティ詳解】
◆ PropertyA
| getset |
プロパティＡの概要
プロパティＡの詳細 (@property 省略)
◆ PropertyB
| getset |
プロパティＢの概要
プロパティＢの詳細 (@property 必須)
◆ PropertyC
| getset |
プロパティＣの概要
プロパティＣの詳細 (@property 必須)
例：@typedef【型定義】
/// @file
/// @brief 型定義の概要
/// @details 型定義の詳細 (@@typedef 省略)
typedef unsigned int UINT;
typedef unsigned long ULONG;
/// @typedef ULONG
/// @brief 型定義の概要
/// @details 型定義の詳細 (@@typedef 必須)
【HTML出力例】
◆ UINT
| typedef unsigned int UINT |
型定義の概要
型定義の詳細 (@typedef 省略)
～.cpp の nnn 行目に定義があります。
◆ ULONG
| typedef unsigned long ULONG |
型定義の概要
型定義の詳細 (@typedef 必須)
～.cpp の nnn 行目に定義があります。
@showrefby【参照元の表示】
@hiderefby【参照元の非表示】
@showrefs【参照先の表示】
@hiderefs【参照先の非表示】
メモ
- 参照元の表示有無を記述
- @showrefby【参照元の表示】 ・@hiderefby【参照元の非表示】 (REFERENCED_BY_RELATION【参照元の表示有無】は無視)
- 参照先の表示有無を記述
- @showrefs【参照先の表示】 ・@hiderefs【参照先の非表示】 (REFERENCES_RELATION【参照先の表示有無】は無視)
- 外部リンク
構文
@showrefby
@hiderefby
@showrefs
@hiderefs
例
/// クラスの説明
class ClassRef
{
public:
/// データＸの説明 (参照元の表示)
/// @showrefby
int dataX;
/// データＹの説明 (参照元の非表示)
/// @hiderefby
int dataY;
/// メソッドＡ１の説明 (参照先の表示)
/// @showrefs
void MethodA1() {
dataX = 1;
dataY = 2;
MethodB1();
MethodB2();
};
/// メソッドＡ２の説明 (参照先の非表示)
/// @hiderefs
void MethodA2() {
int x = dataX;
int y = dataY;
MethodB1();
MethodB2();
};
/// メソッドＢ１の説明 (参照先・参照元の表示)
/// @showrefs
/// @showrefby
void MethodB1() {
MethodC1();
MethodC2();
};
/// メソッドＢ２の説明 (参照先・参照元の非表示)
/// @hiderefs
/// @hiderefby
void MethodB2() {
MethodC1();
MethodC2();
};
/// メソッドＣ１の説明 (参照元の表示)
/// @showrefby
void MethodC1() {};
/// メソッドＣ２の説明 (参照元の非表示)
/// @hiderefby
void MethodC2() {};
};