注释通常用于:
1、版本、版权声明;
2、函数接口声明;
3、重要代码行提示
添加注释的注意事项:
1、注释量一般占代码量的40%;
2、注释放在代码上方或右方;
3、函数定义前加一个合适的函数头,说明该函数的功能、参数、返回值等
4、边写代码边写注释,保证注释与代码的一致性,修改代码时必须同时修改注释,没用的注释删除;
5、避免在注释中使用缩写;
6、代码比较长时,尤其是有多重嵌套时,应当在一些段落结束处加注释,以便于阅读。
Microsoft程序员Charles Simonyi的“匈牙利”命名法:
1、望文生义
通常前缀g_表示全局变量,m_表示成员变量,s_表示静态变量,p表示指针等
2、避免标识符过长
3、避免歧义,避免使用靠大小写区分的标识符,也不要在不同作用域使用相同名字的标识符