代码规范

俗话说无规矩不成方圆，开发软件也是如此，一款软件的代码程序需要有统一的规范、标准，才能成为成功的好的软件。这样的程序对后续的开发和扩展有很大的帮助。
一个规范的代码程序有很多的好处：
1、规范的代码程序有着更好的逻辑关系，清晰地逻辑结构，这有助于后续活动的人进行理解、添加；
2、规范的程序能有效的减少BUG，有助于发现BUG，及时改正；
3、规范的程序有助于代码的维护，提高代码质量；
4、规范的程代码能够节约成本，提高开发效率；
…
规范的代码程序还有很多优点，那么现在我们来说一下关于代码规范的东西。

一、命名规范

1.利用命名方法

1.Pascal命名法：所有单词的首字母都大写，其他字母小写
2.Camel命名法：除首字母外，其他单词的首字母大写，其他字母小写

2.命名的一些小规则

1.名字一律使用英文单词，而不能为拼音。
2.名字可以有两个或三个单词组成但不应多于4个，控制在3至30个字母以内。
3.所有变量、方法、类名：见名知意
4.类成员变量：首字母小写和驼峰原则。如monthSalary
5.局部变量：首字母小写和驼峰原则
6.常量：大写字母和下划线。如MAX_VALUE
7.类名：首字母大写和驼峰原则。如Man, GoodMan
8.方法名：首字母小写和驼峰原则。如run(), runRun()

3.注释的规则

1.一般情况下，源程序的有效注释量必须在30%以上。
2.保持注释的简洁。
3.注释信息不仅要包括代码的功能，还应给出原因
4.除较短语句的注释可用行尾注释外，其他注释当避免使用行尾注释。
5.如果注释太复杂说明程序需要修改调整，使设计更加合理。
6.getter、setter方法不用注释
7.注释不能嵌套
8.生成开发文档的需要用中文编写
9.如果需要注释的内容太多，需附加文档进行说明， 注释时加上"参见《****》"
10.距离较远的}必须注释
11.复杂的分支流程必须注释

四、编码规则

1.大括号的书写规则
2.缩进规则：使用一个“Tab”为每层次缩进
3.小括号规则
3.1小括号和关键词用空格隔开它们；
3.2不要把小括号和函数名紧贴在一起；
3.3除非必要，不要在Return返回语句中使用小括号；
4.没有特殊情况每行只写一个语句；
5.编码风格规则：
5.1关系运算必须常量在左、变量在右。
5.2不许使用复杂的运算表达式，必要时添加括号而不依赖于优先级。
5.3魔鬼数字需用宏定义替代。
5.4局部变量必须初定义、避免不必要的内存操作、内存操作定考虑异常处理。
5.5代码未写，文档先行，注释必须按照固定统一范式撰写。

五、版本管理规则

1.当源码包初版时，版本号为 V1.00；
2.当源码包被局部修改或bug修正时，发行号不变，修改号第二个数字增1。例如，对初版源码包作了第一次修订，则版本号为 V1.01；
3.当源码包在原有的基础上增加部分功能,发行号不变，修改号第一个数字增1，例如，对V1.12版的基础上增加部分功能，则新版本号为 V1.20；
4.当源码包有重要修改或局部修订累积较多导致源码包发生全局变化时，发行号增1。例如，在 V1.15 版的基础上作了一次全面修改，则新版本号为 V2.00。