6. 注释

1.    函数注释

（1）函数声明部分注释函数的用法，实现部分注释函数实现的操做。

（2）声明部分注释的信息

a.    输入和输出；

b.    对于类成员函数，在该方法的调用周期外，对象是否有引用参数，它是否会释放这些引用；

c.    若是一个函数申请了内存，它必须释放它们；

d.    参数是否能够是空；

e.    函数的使用方法是否会影响其性能；

f.    若是函数可重入，是怎么实现同步的；

2.    变量注释

（1）全部全局变量应该有一个描述其功能及其意义的注释。

3.    以NULL、true/false、1/2/3等做为参数

（1）函数传入NULL、布尔值和整型值时，应该增长注释说明这些值的意义，或者使用常量使代码自文档化。