目次
1--一般的に使用されるアノテーション仕様
① @brief は導入を意味し、関数やクラスの役割や機能を簡単に紹介するために使用されます。
② @param はパラメータを表し、関数またはクラスのパラメータの導入と説明に使用されます。
③ @return は戻り値の型を表し、関数の戻り値の型を記述するために使用されます。
④ @author は著者を表し、著者情報を紹介するために使用されます。
⑤ @data は日付を表し、日付情報を導入するために使用されます。
⑥ @version はバージョンを表し、バージョン情報を導入するために使用されます。
⑦ @Exception は、考えられる例外情報を記述するために使用されます。
⑧ @property は属性を表し、属性情報を記述するために使用されます。
⑨ @retval は戻り値を表し、戻り値の意味を説明するために使用されます (たとえば、-1 は例外を示します)。
2 -- コード例
/** */ を使用して 地域ごとのコメントを作成することも、///を使用して個別のコメントを作成することもできます。
#include <iostream>
int my_func1(int param1, int param2){
/**
@brief A function that calculates the sum of two input integers.
@param param1: The input interger.
@param param2: The other input interger.
@return int.
@author liujinfu.
@date 2023.09.15.
@version 1.0.
*/
return param1 + param2;
}
int my_func2(int param1, int param2){
/// @brief A function that calculates the sum of two input integers.
/// @param param1: The input interger.
/// @param param2: The other input interger.
/// @return int.
/// @author liujinfu.
/// @date 2023.09.15.
/// @version: 1.0.
return param1 + param2;
}
int main(int argc, char* argv[]){
int a = 1, b = 2;
int c = my_func1(a, b);
std::cout << c << std::endl;
return 0;
}