visual studio中番茄助手添加注释模板

疼疼国王

已于 2022-05-18 14:08:01 修改

阅读量1.1k

点赞数

CC 4.0 BY-SA版权

分类专栏：工具 C/C++ 文章标签： visual studio C++

于 2022-05-18 14:07:09 首次发布

本文链接：https://blog.csdn.net/sinat_36304757/article/details/124841100

C/C++ 同时被 2 个专栏收录

19 篇文章

订阅专栏

工具

3 篇文章

订阅专栏

本文档详细介绍了C++编程中文件、类、函数的注释规范，包括文件头部注释、类注释、函数注释的标准格式，以及防止头文件重复包含的宏定义。这些规范旨在提高代码可读性和维护性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一、文件注释

/**
  * @file   $FILE_BASE$.$FILE_EXT$
  * @brief Thisis a brief description.
  * @author ${Author}
  * @par   Copyright (c):
  *          ***.
  *         All Rights Reserved
  * @date   $DATE$
  *  @note   matters needing attention
  *  @version 1.0
  */

二、类注释

/**
  * @class <class‐name>
  * @brief  This is a brief description.
  * @author ${Author}
  * @note   matters needing attention
  */

三、函数注释

/**
  *  @brief  Thisis a brief description.
  *  @param[in]  inArgName input argument description.type name:purpose(Range)
  *  @param[out] outArgName output argument description.
  *  @Return:    $SymbolType$:description of the return value
  */

四、头文件防止重复包含

#ifndef _$FILE_BASE_UPPER$_$FILE_EXT_UPPER$_
#define _$FILE_BASE_UPPER$_$FILE_EXT_UPPER$_

$selected$
#endif // _$FILE_BASE_UPPER$_$FILE_EXT_UPPER$_