第一篇blog,瞎写写,只是个编程小白而已,却也混了快三年了,越发觉得这个编程规范甚为重要,在这我也就想起来一点写一点,下面正文。
貌似主要分为变量篇 和 注释篇。
变量:首先是常规的变量命名规范:不要用汉语拼音,更要避免拼音首字母,一个好的规范应该是这个变量代表的意思的英文单词,或者缩写。
举例:车子 用Car 而不是che,猫用Cat而不是mao,关于变量命名的话,还有几个比较通用的规范 ,普通变量可以英文单词首字母大写其余小写,两个单词的也是这样,比如CarIndex,PlayerCount,还有一种是除了第一个单词全部小写外,其它的首字母大写,比如carIndex,playerCount,以上适用于普通变量命名。在某些情况下,最好加上前缀标示一下此变量的类型,比如bool类型的可以用Is_xxxxx或者IsXxxx,Point类型的就用pt_Xxxx或者ptXxxxx。
常量的命名尽量采用全部大写的单词,PLAYERCOUNT或者CAT_COUNT;
不要让诸如a,b,c,d,i,j,k,等此类标识符出现在代码段中,即便是“活的很短”的变量,最典型的就是for循环括弧里面的i or j or k ,,for(int i=0;i<j;i++) ,请将这段代码替换为诸如
for( int xxIndex = 0; xxIndex < xxCount ; xxIndex++) 此类的代码。
尽量避免代码块中出现任何的数字,定义变量的不算,我们应尽量把这些数字替换成常量或者变量等加到一个文件里。
注释:变量有变量的注释,函数头有函数头的注释,表达式有表达式的注释,代码段有代码段的注释,各种注释的形式也都不一样,具体参考语言或者IDE的属性,尽量写的整洁,错落有致,该有的注释一定要有,注释要说明的是WHY 而不是 HOW 。
一篇好的代码,应该就跟读文章一样让人一目了然。
先到这里 ,睡觉了。。。。