最近接手一个较大项目的代码,在阅读代码的过程中,发现下面可以利于自己的代码被其他人的tips,或许都是简单的规则,但是却发现十分的重要。
1)凡是数据结构中声明的变量都要有注释标识它的作用;
2)凡是全局变量的声明都需要注释;
3)凡是函数的声明处都需要添加注释;
4)全局变量的命名要一望便知,这个变量名不能是一个很通用的名词,可以考虑使用g_前缀。
最近接手一个较大项目的代码,在阅读代码的过程中,发现下面可以利于自己的代码被其他人的tips,或许都是简单的规则,但是却发现十分的重要。
1)凡是数据结构中声明的变量都要有注释标识它的作用;
2)凡是全局变量的声明都需要注释;
3)凡是函数的声明处都需要添加注释;
4)全局变量的命名要一望便知,这个变量名不能是一个很通用的名词,可以考虑使用g_前缀。