注释规则

1.注释是对代码的“提示”，而不是文档

2.如果代码本来就是清楚的，则不必加注释。

3.边写代码边注释

4.注释应当准确、易懂，防止注释有二义性

5.尽量避免在注释中使用缩写，特别是不常用缩写。

6.注释的位置应与被描述的代码相邻

7.当代码比较长，应当在一些段落的结束处加注释

注释实例：

/*

* 函数介绍：

* 输入参数：

* 输出参数：

* 返回值：

*/

void Function(floatx, float y, float z)

{ 

…

}