一、代码规范存在的意义
1、好的编码规范可以尽可能的减少一个软件的维护成本。
2、好的编码规范可以改善软件的可读性,可以让开发人员尽快而彻底理解新的代码。
3、好的编码规范可以最大限度的提高团队开发的合作效率。
4、长期的规范编码可以让开发人员养成好的编码习惯,甚至锻炼出更加严谨的思维。
二、代码规范有哪些
1、注释规范(自建代码文件注释、标准注释、代码间注释)
注释好处:有助于保持一致,有助于理解,有助于加快开发过程,有助于提高协作效率
2、命名总结规范注意事项
a、名字应该能够标识事物的特性,并且与业务挂钩。
b、名字一律使用英文单词,而不能为拼音。
c、名字可以有两个或三个单词组成,但不应多于4个,控制在3至30个字母以内。
d、在名字中,多个单词用大写第一个字母(其它字母小写)来分隔。例如:IsSuperUser。
3、命名规范注意事项
a、命名方法(Pascal命名法:所有单词的首字母都大写,其他字母小写。Camel命名法:除首字母外,其他单词的首字母大写,其他字母小写)
b、在变量名中使用互补对,如 min/max。即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用有意义的名称。仅对于短循环索引使用单字母变量名,如 i 或 j。
c、缩写(不要将缩写或缩略形式用作标识符名称的组成部分。例如,使用 GetWindow,而不要使用 GetWin。 适当的时候,使用众所周知的缩写替换冗长的词组名称。例如,用 UI 作为 User Interface 缩写,用 OLAP 作为 On-line Analytical Processing 的缩写。对于某些名字中单词都比较长的情况,可以自行写一个缩写名字(名字中的关键字不能缩写),将所有的缩写做一个说明文件,放在同级目录下的开头)
d、参数(参数名称使用Camel命名法,参数名称可以大小写)
4、编码规则
a、小括号规则(不要把小括号和关键词(if 、while等)紧贴在一起,要用空格隔开它们)
b、版本管理规则(本项目中,每个任务在完成一个稳定的版本后,都应打包并且归档。源码包的版本号由圆点隔开的两个数字组成,第一个数字表示发行号,第二个数字表示该版的修改号)