背景：接上回，上回说的是变量。
1、函数不能太长。抽离方法和重命名操作，会让函数更清晰。
2、短小。函数第一条规则是短小，第二条规则是更短小。
比如if语句、else if语句、while语句，里面的代码应该只有一行，甚至里面应该是一个函数。（简单的例子：if(isTestPage(pageData))会比if(pageData.endwith("test"))更容易让人看懂，因为if里面的内容抽离出了一个方法，而且多了一个易懂的方法名。当然，我觉得，如果if里的判断简单，就不需要如此，如果if里面的逻辑比较复杂，让人不是一眼就能看明白，就应该抽离出一个函数名）
3、函数应该只做一件事。
这里说的一件事，是说同一抽象层上的一件事。（比如，举个简单的例子，同一个函数里有，校验、读取、写入a系统，写入b系统，等等事情，而如果这些逻辑多简单罗列在一个函数里，这个函数就不算只做一件事，而且代码会冗长，极其难于读懂，而其实这几个逻辑，是同一抽象层的，如果把他们抽离出来，然后都命名成一个易懂的函数名，那么包含他们的大函数，就还算只做一件事，同一抽象层上的一件事。这样，我看这个函数的时候，我不需要看所有的部分，我只需要看我关注的东西。）
4、每个函数一个抽象层级。
这个上面说了。
5、使用描述性的名称。
1）如果函数短小，功能越集中，就越便于取一个好名字。
2）别害怕长名称，长而具有描述性的名称，要比短而令人费解的名称好。长而具有描述性的名称，要比描述性的长注释好。
3）命名也应该有一个约定，而且保持一致（比如一下叫save，一下叫insert，一下叫remove，一下叫delete。）
6、函数参数。
1）函数参数当然是越少越好，最好是没有，其次是一，再次是二，尽量避免出现三个。（但是其实很多情况很难做到）
2）不要出现输出参数，比如：StringBuffer传进去，然后修改，然后调用方法之后，直接使用这个Stringbuffer。list这种集合也有这种情况。（因为，人长久的编程习惯是，参数只做输入，输出应该来自于他的返回值。我曾经就碰到过一个同事，list作为输出参数传进去，之后，半天理解不了）
3）标识参数比较丑陋。比如传一个boolean类型进去，然后，if else分别做处理。因为这就说明这个函数不止做的一件事情。（当然，并不是说完全不能这么做，而是应该避免尽量少的地方这样做，比如在一个地方做一下if else，然后路由到下一个抽象层的函数里，函数名易懂的话也比较容易理解）
4）超过3个参数就应该封装成类。（这里，我觉得并不绝对，因为如果说，你封装成的类，不具有的一个整体概念，而只是为了封装而封装，反而多了一个类，复杂的代码。比如makeCirCle(double x, double y, double radius)，封装成makeCircle(Point center, double radius)，就可以，因为，画一个圆，圆点、半径就可以了，容易理解，可以封装。但是如果胡吞吐枣的封装，就完全没有意义）
7、函数命名，可以动词加关键字的形式，关键词是跟参数名有关。
比如write（String name），改成writeName(String name)。
8、无副作用。
（函数的命名不能存在副作用，比如存在误导性的东西。
很常见的情况。validateXXX()这种，结果函数里面还存在写操作，就会存在很大的误导性，因为一般说validate只是校验一下而已，结果没想到你还有写操作，你可以把写操作也命名到函数名种去）
9、分割指令与询问。
if(set(a))这样，本意是set进去了就返回true，否则返回false，但是其实是很难理解的，别人可能理解成，如果已经存在过值了，就返回false，从来不存在过就返回true。
你可以命名成setIfExisit。甚至，你可以把set指令和询问分开，if !exist then set。
10、使用异常代替错误码。
函数出现错误，用错误码会加深嵌套的层次，因为函数返回错误码，调用这个函数的外面还需要对错误码进行if else处理，函数的外面的外面还需要这样处理。
11、抽离 try catch代码块。
try catch这种结构，很明显的让人感觉这个函数方法做的不是一件事情。
所以应该尽可能少的地方使用这种代码块，而且尽可能的抽离出来。（我觉得看情况，反正可读性是最基本的标准）
12、别重复自己。
代码重复，这个是肯定不能忍受的。
总结：写代码当作写文章一样，初稿粗陋无序，然后斟酌推敲。代码也一样，开始写的时候，也会比较low，之后打磨代码、分解函数、修改名称，消除重复。（哪有那么时间。。。）
网友评论