我的编程规范

众所周知,无论是什么代码,代码的可读性都是非常重要的.尤记得参加华为软件精英挑战赛(2018)时,晚上看自己写的代码看的都心累.究其原因,主要原因是变量和函数命名,和注释没写得好.

coding既然是我的职业,那么我应该学会把代码变美,把自己的代码也深化为一种艺术(微笑脸+严肃脸),让自己和他人都看得清楚.

以下就是我自己给自己定的编程规范,我也会在平时的编程中注意这些,以养成一个良好的编程习惯.

1.关于注释

关于注释的一些要求,要逐渐转向使用英语注释.英语有时候能够更加准确的表达,当然由于英语水平有限,偶尔也可以使用中文.

• 简洁性:对于常见的算法以及显而易见的表达式不做注释,只对容易混淆的变量名和复杂的式子做注释.
• 标志变量和中间变量:尽量少使用中间变量,例如i,j,k这种,可以使用这种命名:number_i,list_i等,容易混淆的中间变量要做注释.
• 可以在函数接口处注释:  如

void add(x/*number of list*/, &y/*address of array num*/）

2.关于命名

命名规范有很多,每个人也有不同的风格,但最基本的要求就是见名只义.

下面是我的命名习惯.

• 函数命名:操作+名词(操作小写,名词大写)

void addList(int num, struct stu);
double searchArray(int begin, int end); //一种常见的命名方式

• 变量命名:一般使用对应的英语单词即可,但有时变量会有归属关系.

int flavor;//the num of flavor
int flavor_cpu;//the num of flavor's cpu
int flavor_mem;

• 中间变量:一般建议少新声明中间变量,如果有需要,建议不要直接使用i,j,k此类变量命名.尤其是在有许多层循环时,不然到后面会不知所措.可以尝试此类命名,如print_i,line_j,row_k等,简单明了.

3.代码风格

个人的习惯而已

//主要是一些代码习惯的问题
int flavor, flavor_cpu, flavor_gpu;//适当空格
flavor = cpu = 5;//适当空格
for(i=0; i<num; i++)//注意空格处

以上只是我的学习笔记,如有错误和建议欢迎不吝赐教,欢迎一起交流技术学习问题.我的博客也会一直更正.