写在前面的话

写代码的时间也不算太多，但是我觉得对于一个程序而言，除了时刻保持好的学习能力之外，还要对于代码的编写由好的习惯，养成好的代码编写习惯，可以提高代码的开发效率

下面讲一下好的代码的基本素养

对于命名:

1、有意义的命名

包名:按照域名全部使用小写

类名：首字母大写

方法名：采用驼峰命名法则

变量名：采用驼峰命名法则

常量：字符大写加下划线方式命名

对于名称要求：

1、名称代表实际意义

2、名称不能随便命名，名称意义与实际操作比匹配

对于方法名应当是动词或动词的短语

3、在系统的开发中，对同一概念用同一个词：

    例如：在一堆代码中，有controller,manager,还有driver，就会令人困惑，DeviceManager和Protocol_Controller之间有何根本的区别？为什么不全用controller或manager?他们都是Drivers吗？这种名称，让人觉得这两个对象是不同的类型，也分属不同的类。

4、别用双关语

       避免将同一单词用于不同的目的。同一术语用于不同的概念，基本上就是双关语了。如果遵守“一词一义”规则，可能在好多个类里面都会有add方法。只要这些add方法的参数列表和返回值在语义上等价，就一切顺利。

 5、添加有意义的语境

       设想你的名称firstName,lastName,street,houseNumber，city,state和ZipCode的变量。可以通过添加前缀的方式提供语境,例如addrFirstName,addrLastName,addrState等等

       但不要添加没有用的语境：

        设若有一个名为“加油站豪华版”(Gas Station Deluxe)的应用，在其中给每个类添加GSD前缀就不是什么好的点子。

        只要短名称足够清楚，就要比长长名称好

函数

1、短小

         常说函数不该长于一屏。

         函数的代码块和缩进

          if语句,else语句,while语句等，其中的代码块应该只有一行。该行大抵应该是一个函数的调用语句。这样不但能保持函数短小，而且，因为块内调用的函数拥有较具说明的名称，从而增加了文档上的价值。

         同时在一个方法内部，不应该大到足以容纳嵌套结构。所以，函数的缩进层级不该多于一层或两层。

        在函数中，不应该编写足够多的嵌套语句，这样的代码会增加的代码的阅读和修改成本。

代码整洁之道

原文：https://www.cnblogs.com/david-jack-steven/p/11488712.html