@param【引数】
@result・@return・@returns【戻り値】
@retval【戻り値の詳細】
@exception・@throw・@throws【例外】
@param【引数】
メモ
- 関数・メソッドの引数を記述
- 過不足は警告 (デフォルト)
- 引数型は自動解析
- 関連
- 外部リンク
構文
@param [[
in]
|[
in,out]
|[
out]
] 引数名 | 引数名リスト (カンマ区切り) 引数の説明
例
/// メソッドの説明
/// @param p1 引数1の説明
/// @param [in] p2 引数2の説明
/// @param [in,out] p3 引数3の説明
/// @param [out] p4 引数4の説明
void MyClass::method(int p1, int p2, int* p3, int* p4)
{
// 処理
}
【HTML出力例】
メソッドの説明
- 引数
p1 引数1の説明 [in] p2 引数2の説明 [in,out] p3 引数3の説明 [out] p4 引数4の説明
/// メソッドの説明
/// @param x,y 2つの引数の説明
void MyClass::method(int x, int y)
{
// 処理
}
【HTML出力例】
メソッドの説明
- 引数
x,y 2つの引数の説明
@result【戻り値】
@return【戻り値】
@returns【戻り値】
メモ
- 関数・メソッドの戻り値を記述
- 隣接するコマンドは、1つの段落に結合
- 即値等の詳細は、@retval【戻り値の詳細】を使用
- 関連
- 外部リンク
構文
@result 戻り値の説明
@return 戻り値の説明
@returns 戻り値の説明
例
/// メソッドの説明
/// @return 戻り値の説明
int MyClass::method()
{
int result = 0;
// 処理
return result;
}
【HTML出力例】
メソッドの説明
- 戻り値
- 戻り値の説明
@retval【戻り値の詳細】
メモ
- 戻り値の詳細を記述
- 隣接する複数の @retval【戻り値の詳細】コマンドは1つの段落に結合
- 空行・他のセクションコマンドで終了
- 一般的な戻り値は、@result・@return・@returns【戻り値】を使用
- 関連
- 外部リンク
構文
@retval 戻り値 戻り値の詳細
例
/// メソッドの説明
/// @retval true 正常終了
/// @retval false 異常終了
bool MyClass::methodA()
{
bool result = true;
// 処理
return result;
}
【HTML出力例】
メソッドの説明
- 戻り値
true 正常終了 false 異常終了
/// メソッドの説明
/// @retval 0 正常
/// @retval <0 警告
/// @retval 0< エラー
int MyClass::methodB()
{
bool result = 0;
// 処理
return result;
}
【HTML出力例】
メソッドの説明
- 戻り値
0 正常 <0 警告 0< エラー
/// メソッドの戻り値
enum enumMethod
{
ENUM_OK = 0, ///< 正常
ENUM_WARNING1 = 100, ///< 警告1
ENUM_WARNING2 = 200, ///< 警告2
ENUM_ERROR1 = (-1), ///< エラー1
ENUM_ERROR2 = (-2) ///< エラー2
};
/// メソッドの説明
/// @retval ENUM_OK 正常
/// @retval ENUM_WARNING1 警告1
/// @retval ENUM_WARNING2 警告2
/// @retval ENUM_ERROR1 エラー1
/// @retval ENUM_ERROR2 エラー2
enumMethod MyClass::methodC()
{
enumMethod result = ENUM_OK;
// 処理
return result;
}
【HTML出力例】
メソッドの説明
- 戻り値
ENUM_OK 正常 ENUM_WARNING1 警告1 ENUM_WARNING2 警告2 ENUM_ERROR1 エラー1 ENUM_ERROR2 エラー2
@exception【例外】
@throw【例外】
@throws【例外】
メモ
- 例外を記述
- 複数指定可能
- 例外オブジェクトの存在は、未チェック
- 関連
- 外部リンク
構文
@exception 例外オブジェクト 例外の説明
@throw 例外オブジェクト 例外の説明
@throws 例外オブジェクト 例外の説明
例
#include <stdexcept>
/// @brief 関数の概要
/// @details 関数の詳細
/// @param x 引数の説明
/// @exception invalid_argument 例外の説明 (不正引数)
/// @exception out_of_range 例外の説明 (範囲外)
void funcException(int x)
{
// 処理
}
【HTML出力例】
関数の概要
関数の詳細
- 引数
x 引数の説明
- 例外
invalid_argument 例外の説明 (不正引数) out_of_range 例外の説明 (範囲外)