C/C++注释规范

注释规范能够提供结构化的注释信息，看起来更有条理，便于快速获取注释信息
并且VS Code的C/C++.IntelliSense（智能提示）会对注释块中特殊标记进行解释，提供代码提示
C/C++风格的注释块规则如下

注释块要紧贴着代码块，否则智能提示不会生效

/**				/**开头
 *
	comments		中间行的星号可选
 *
*/				*/结尾

下面是常用的注释特殊标记
每个特殊标记的作用范围是从当前标记开始，到下一个标记为止

标记前面，后面要留有一个空格

第一部分的标记是函数/方法用的；第二部分通常放在文件头（因为放在函数注释里vscode也不会对其解释）

/**
 *	@brief description			简介
 *	@param [参数] description		参数说明
 *	@return description			返回说明
 *	@retval description			返回值说明
 *	@exception description			异常说明
 *	
 *	@author					作者署名
 *	@date					时间
 *	@version				版本
 
 @tparam	//	模板参数
*/

下面看看注释标签在vscode智能提示中的效果

可以使用标点，或换行符\n增加可读性