一致性原则
// 或者/* */都可以，保持一致即可。
文件注释
.h文件对所声明的类的功能和用法作简单说明，.cpp文件包含更多的实现细节。不要在头文件和实现文件中简单的复制注释，那就失去了一半的意义。
函数注释
头文件中描述函数功能，定义处描述功能实现。
变量注释
成员变量、全局变量都一样，说明其用途即可。
注意拼写和语法
错误的语法，错误的拼写给他人带来困惑与不快，宁愿不写，不可乱写。
中文还是英文
这个看个人喜好，如果英文不过关，就不要硬撑着。注释的本质是帮助别人和帮助自己更好的理解代码，不是炫耀英文或中文水平。
posted on 2011-01-25 18:29 孔雀 阅读(2266) 评论(2) 编辑 收藏 引用 所属分类: C/C++