114. C/C++ 常用注释命令

发表于 更新于 分类于

常用命令

1
2
3
4
5
6
7
8
9
10
11
12
13
14
@attention           注意
@author              作者
@bug                 缺陷，链接到所有缺陷汇总的缺陷列表
@brief               简要注释
@code                代码块开始，与 “endcode” 成对使用
@endcode             代码块结束，与 “code” 成对使用
@details             详细注释
@date                日期
@file                <文件名> 文件参考，用在文件注释中
@param               参数，用在函数注释中
@return              返回，用在函数注释中
@todo                TODO，链接到所有 TODO 汇总的 TODO 列表
@version             版本
@warning             警告

Vscode 用户自定义片段

个人设置

1
2
3
4
5
6
7
8
9
10
11
"cppDocuNote": {
   "prefix": "docuNote",
   "body": [
      "/**",
      "* $1",
      "* @param: $2",
      "* @return: $3",
      "*/$0",
   ],
   "description": "Documentation notes"
}

实例

1
2
3
4
5
6
7
/**
 *〈一句话功能简述〉
 *〈功能详细描述〉
 * @param [参数 1] [参数 1 说明]
 * @param [参数 2] [参数 2 说明]
 * @return [返回类型说明]
 */