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

admin

一、文件注释
/**
  * @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$采用