代码简洁之道

1.命名要有意义

  • 如方法名:动宾
  • 命名要能读得出来
  • 命名具有一致性,且尽量使用领域内专业术语

2.函数

  • 函数尽量短小
  • 每个函数只抽象一次
  • 函数参数越少越好,超过三个说明参数需要封装(如封成一个类)

3.注释

  • 需要注释基本可以代表代码整体的表达能力不好,可读性不好,wtf太多,是不是代码耦合度太高
  • 能用命名解决的就不要用注释
  • 拒绝喃喃自语、多余的废话注释及注释掉的代码

4.格式

  • 行不要太长,不超过120字符
  • 竖直方向的区隔
  • 水平方向的缩进
  • 空格对于运算符优先级的凸显,如 2*a + 3*b

5.错误处理

  • 使用异常代替返回错误码
  • 逐步测试,缩小异常的控制区;
  • 最终将 try... catch() 从代码段中抽离,仅实现在一个具体的小函数定义中

6.类

  • 类尽量短小
  • 保持类的内聚性:每个方法都尽可能多的用到类的变量

7.迭进

  • 逐步改进,逐步优化代码
  • 首先能起作用,再起好作用
  • 尽可能少的类和方法

8.测试多线程代码

  • 先使线程代码可工作
  • 编写可插拔的线程代码
  • 编写线程数量可调整的线程代码
  • 运行多于处理器数量的线程
  • 在不同平台上运行
  • 装置试错代码:方法1硬编码,方法2自动化
原文地址:https://www.cnblogs.com/Henry-ZHAO/p/12725122.html