简易注释规范

在哪些地方写注释？

1、在重要的文件首部，序言性注释

　　文件名 + 功能说明 + [作者] + [版本] + [版权声明] + [日期]

2、在用户自定义函数前

　　对函数接口进行说明

　　函数功能 + 入口参数 +出口参数 + 返回值 （包括出错处理）

3、在一些重要的语句块上方

　　对代码的功能、原理进行解释说明

4、在一些重要的语句行右方

　　定义一些非通用的变量

　　函数调用

　　较长的、多重嵌套的语句块结束处

5、在修改的代码行旁边加注释