软件开发时的通用代码规范和准则

从事软件开发这么多年，开发过形形的软件和系统，也做过不少的代码优化工作，对于代码规范的重要性也是深有体会，今天我就来总结一下软件工程师在进行软件开发的时候，对于代码规范的一些操作准则。



1，名字要简洁易识别，能反映变量或者方法的使用场景。程序的变量和方法要有明确的命名，最好不要命名为a,b,c或者x,y,z之类的，要有实质的意思，采用英文单词或者多个单词拼接的方法，例如，对于关键词的变量就取名为keyword，对于获取alexa排名的方法就取名为getAlexaRank()，等等。

2，一个方法只做一件事。尽量做到一个方法只做一件事情，不要做过多的事情。例如，在一个java类中，需要做这样一件事情，而这件事情要分为三个步骤，则一个好的代码书写的准则就是，这件事情就分为三个方法实现，而最好不要将这三个步骤的事情放在同一个方法中。

3，控制好代码的换行和缩进。写代码有如写文章，要控制好代码的换行和缩进，一般一行代码不要超过80个字符，有if或者for的时候，内部的逻辑代码要注意缩进。

4，控制好代码的循环。一般尽量减少for循环的嵌套，最好不要超过两层，否则就会影响到代码的高效性。

5，做好代码注释。代码注释做到少而精，当然，不需要每个地方都要写代码注释，只需要在关键的地方，或者容易被错误理解的地方加上必要的注释，这样有两个好处，一是方便自己在后期进行维护，二是方便别人接手自己的代码进行修改。

6，方法的代码量要尽量少。一般一个方法的代码行数不要太多，100行到200行足够了，200行以上的代码量是不可取的，不容易被别人看懂，也不易于后期维护。

7，对代码经常优化和重构。开发时一次性写好的代码，算法和效率都不一定很高，往往你在后来看到自己所写代码的时候，会觉得方法不够合理，或者效率不够精炼，所以就需要及时的优化和重构，以达到代码精炼的程度，这样可以有效的节省硬件资源，并能提高程序的反应时间。

8，多考虑代码的边界效应和异常情况。一个好的开发工程师，一定要考虑到代码可能产生的异常情况，对于java来说，考虑的一般有，变量是否为null，数据类型转换是否满足条件，数组是否越界，等等。

9，对编写好的代码做好单元测试工作。为了保证代码片段的功能正确性，一定要在平时做好代码的单元测试工作，在实现的方法中，是否按照严格的输入，产生了正确而无二义性的输出等等。

要做好软件开发，编写出高质量的代码，遵循以上的这些代码规范，相信会有很大的裨益，就等着你平时融会贯通和不断地改进啦。