代码规范

重要性：

规范的代码可以促进团队合作：

一个项目大多都是有一个团队来完成，如果没有统一的代码规范，那么每个人的代码必定会风格迥异。且不说会存在多个人同时开发同一模块的情况，即使是分工十分明晰的，等到要整合代码的时候也有够头疼的了。统一的风格使得代码可读性大大提高了，人们看到任何一段代码都会觉得异常熟悉。显然的，规范的代码在团队的合作开发中是非常有益而且必要的。

规范的代码可以减少bug处理：

有的时候一个很简单的程序，在进行迭代的时候，会出现特别多的bug，这里很大程度上是由于代码不规范所致，没有对输入输出参数的规范，没有规范的异常处理等等，当我们出现bug时，很难找到引起bug的原因。相反，在规范的开发中，bug不但可以有效减少，查找bug也变得轻而易举。

规范的代码可以降低维护成本：

维护工作不仅仅是读懂原有代码，而是需要在原有代码基础上作出修改。我们可以先想像没有统一风格的情况下，A完成开发以后，B进行维护加一段代码，过一段时间C又加一段代码。。。。。。直到有一天X看到那一大堆乱码想死的心都有了，维护也就进行不下去了。因此，统一的风格有利于长期的维护。

有助于自身的成长：

你相信吗？代码规范开发最大的受益人是自己！

你有没有花费很多的时候查找自己的代码呢？尤其是出现bug的时候需要逐行的调bug？自己写的代码太乱，没有头绪。我们应该做的就是规范开发，减少自己出现的错误。因此，代码规范最大受益者是我们自己。

如何做：

注释规范：　

• 在模块，类，属性，方法前一行添加注释，对下面的代码做出说明，以便调用的时候提示用户
• 代码中遇到语句块时必须加注释,说明此语句块的作用和实现手段
• 对代码进行修改时,每次修改必须添加注释,说明修改内容

命名规范：

• 名字应该能够标识事物的特性,并且与业务挂钩
• 名字一律使用英文单词,而不能为拼音
• 名字可以有两个或三个单词组成,但不应多于4个,控制在3至30个字母以内
• 在名字中,多个单词用大写第一个字母其他字母小写来分隔

四种命名方法:

详细总结：https://blog.csdn.net/TGB_Tom/article/details/103665787

• Pascal命名法:所有单词的首字母大写,其他字母小写(命名空间,类,接口,方法,属性,委托,事件,静态字段)
• Camel命名法:除首字母外,其他单词的首字母大写,其他字母小写(参数,字段)
• Hungarian命名法：要求标识符的名字以一个或多个小写字母开头作为前缀：前缀之后的是首字母大写的一个单词或多个单词组合，该单词要知名变量的用途
• 下划线命名法：要求单词与单词之间通过下划线连接即可

编码规则：

• 代码未写，文档先行，注释必须按照固定统一范式撰写。
• 关系运算必须常量在左、变量在右。
• 不许使用复杂的运算表达式，必要时添加括号而不依赖于优先级
• 局部变量必须初定义、避免不必要的内存操作、内存操作必须考虑异常处理。