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

• 常用命令

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

• vscode 用户自定义片段

  "cppDocuNote": {
      "prefix": "docuNote",
      "body": [
          "/**",
          " * $1",
          " * @Params: $2",
          " * @Return: $3",
          " */$0",
      ],
      "description": "Documentation notes"
  }