论写作的规范

1 写作的目的

写作的目的是为了让人阅读。所以写作的风格取决于读者，而不是作者。
作为一篇好文章，一般都具有以下特点：

1. 结构整洁，中心明确。
2. 语言易懂，逻辑清晰。

不是展现作者华丽的辞藻，也不是节约出版社的纸张。

2 的写作风格

每一个作者都有自己的写作风格。我这里总结的是小钢炮多年以来拜师学艺的东西。希望能给到一定参考作用。

1. 方法的行数小于40行。
2. 变量和方法命名规范。
3. 圈复杂度小于10。
4. 一个方法一个return。

2.1 方法行数小于40行

一个方法的逻辑能否看懂，第一区分办法就是方法的体量。一个方法体量庞大，其阅读理解难度必然上升。至于小于40行是一个经验数值。

2.2 变量和方法命名规范

语言具有很大的通用性，其中变量命名就是。每个项目都有自己的规范。但是变量的一致性，可以很大程度上加强代码的易读性。

2.3 圈复杂度小于10

圈复杂度是强调逻辑的分支的个数，逻辑每多一个分支，圈复杂度就是上升。在代码中，少些循环和分支判断，这个很重要。

2.4 一个方法一个return

一个方法，一个入口，一个出口，这是最简洁清晰的逻辑。随意return会造成很多问题。