规范级别:规则 规则描述:
●在函数的声明之前,要给出精练的注释(不必牵扯太多的内部细节),让使用者能够快速获得足够的信息使用函数。格式不做具体要求。 ●在函数的定义之前,要给出足够的注释。注释格式要求如下:
/*************************************************************************
【函数名称】 (必需) 【函数功能】 (必需) 【参数】 (必需。标明各参数是输入参数还是输出参数。) 【访问变量】 (必需。列出该函数访问的全局变量、成员变量。) 【返回值】 (必需。解释返回值的意义。)
【使用情况】 (必需。调用其它函数的情况,被调用的情况) 【开发者及日期】 (必需)
【版本】 (必需)
【更改记录】 (若有修改,则必需注明)
*************************************************************************/ 理由:
提高代码的可读性。
2.2.2 对类进行注释
规范级别:规则 规则描述:
● 在类的声明之前,要给出足够而精练的注释。注释格式要求如下:
/*************************************************************************
【类名】 (必需) 【功能】 (必需)
【接口说明】 (必需) 【开发者及日期】 (必需)
【版本】 (必需) 【版权信息】 (可选)
【更改记录】 (若修改过则必需注明)
*************************************************************************/ 理由:
提高代码的可读性。
2.2.3 对文件进行注释
规范级别:规则 规则描述:
在头文件、实现文件的首部,一定要有文件注释,用来介绍文件内容。
注释格式要求如下: