代码整洁之道
1.要有代码
代码的整洁是非常重要的,很多时候我们不是在敲写代码,而是在试着读懂代码。糟糕的代码只能让人望而生畏,无从下手;
而整洁的代码则会使我们轻松的了解代码书写者的意图以及代码所做的事。而大家对代码整洁有着不同的认知,不过整洁的代码
一定是要减少重复,提高表达力,构建简单抽象。也可以说成:消除重复,
2.有意义的命名
代码中命名的地方有很多,要给变量、函数、类、包、文件等等进行命名,取个好的名字能让我们一眼看出他的作用而不需要添加多余的注释
好的名字有以下规则:
- 名副其实: 命名应该告诉我们他为什么存在,他做什么事,应该怎么用
- 避免误导: 避免留下掩藏带啊吗本意的错误线索
- 使用有意义的区分: 不能给命名添加数字系列和废话
- 使用读的出来的名称: 命名可以读出来,而不是全是单词缩写
- 使用可搜索的名称: 避免使用单字符名称
- 避免使用编码:不要把类型或作用域编进命名中
- 避免思维映射: 明确即是王道
- 类名: 类名和对象名一般是名词或名词短语
- 方法名: 方法名一般是动词或动词短语
- 别扮可爱: 避免使用俚语
- 每个概念对应一个词: 每个抽象概念选一个词并且一以贯之,不要出现control和manager这样表达一个概念用不同的单词的现象
- 别用双关语: 避免同一单词用于不同目的,同意术语用于不同概念
- 使用解决方案领域的名称: 尽量用计算机科学术语,算法名,模式名毕竟读你代码的也是程序员
- 使用源自所涉问题领域的名称: 当不能使用程序员所熟悉的术语时使用所涉问题领域的术语
- 添加有意义的语境,避免添加没用的语境
3. 函数
我们以前的系统由程序和子程序构成,再后来系统由程序、子程序和函数构成,后来只有函数存活下来。函数是所有程序中的第一组代码,
因此写好函数对我们程序员来讲尤为重要,好的函数一般有以下规则:
- 短小: 一个函数能够在20行封顶最佳
- 只做一件事: 函数应该做一件事,做好这件事,只做这件事。
- 每个函数一个抽象层级: 函数的语句要在统一抽象层级上
- switch语句: 无法避免switch语句,但是要确保每个switch都隐藏在较低的抽象层级中,并且永远不重复
- 使用描述性的名称: 给你的函数取个好名字,让他深合己意
- 函数参数: 最理想的参数数量是0,其次是1个,再次是2,应尽量避免三个参数的函数
代码整洁之道
代码是我们必不可少的,整洁的代码就像讲好一个故事一样,让人能够跟着书写者的思路把一个“故事”了解透彻。好的代码能够提高我们对代码的修改和迁移的效率。果断决绝,就事论事,没有犹豫和不必要的细节这些都是整洁代码的体现。我们要做到减少重复代码,提高表达力,构建简单抽象等方面才能写出整洁的代码。整洁代码的体现有: