代码整洁?

  • 代码永远存在,无论软件行业发展,代码永远是各种工具的基石地基,没有代码这些东西工具也不会存在,无代码运动就是个笑话
  • 糟糕的代码会给项目发展逐渐显现弊端,混乱增加,生产力下降,最后趋于零,这是非常可怕的。
  • 花时间保持代码整洁不但有关效率,还有关生存。整洁你的代码,保护你的饭碗。
  • 多数经理想要好代码,他们想要知道代码实情,所以不应当羞于高数项目进展实情
  • 写出整洁的代码是困难的,需要技巧和不断练习
  • 整洁代码读起来是愉悦的,糟糕的代码会引发混乱,别人修改往往会越来越乱
  • 代码应当讲述事实,不引人猜测,便于其他人增加修改
  • 如何整洁你的代码,不如说是如何在意你的代码
  • 不要重复代码,只做一件事,表达力,小规模抽象

名字要起的有意义

  • 变量,函数,类的名字就应该能解释大部分的东西,备注都是额外的,能做到不需要额外备注就是最好的
  • 避免取容易引发歧义猜测的名字,比如一些专有名字,大家耳熟能详但在代码中缺失另一种含义的名字
  • accountList 除非你是真的用List类才这样写。否则还是写成AccountGroup吧
  • 太过相似的变量名也不合适,应该做容易区分的,尤其是“I”“l” 还有“O”“0”
  • 取a1,a2,这种名字没有目的叫人恶心
  • ProductData和ProductInfo这种也是应该避免的,因为两者含义相同,是废话
  • 名字中带变量名是废话,String类起一个NameString名字纯属废话,除非你真的指明了该名字含义下确实有不同类型
  • 多从读者出发,想想读者会怎样理解猜测
  • 取一些容易读出来的名字,别在乎你那自造词了,modymdhms->modificationTimestamp
  • 使用好搜索的名字,缩写名字不一定是好习惯,会造成搜索困难
  • 避免使用编码
  • 前缀没有必要了
  • 类名应该用名词或名词短语
  • 方法名应该是动词或动词短语,get,set,is这种前缀
  • 不要用双关语,遵循一词一意
  • 取专业领域的技术名称会靠谱很多
  • 问题领域的命名就用问题领域的名称
  • 如果很难分清某个单独放置在某处的变量,该变量名称最好加上前缀
  • 也别太滥用没有意义的前缀,给自动补全添堵,前缀应该用在难以区分辨别的时候

函数

  • 函数应该尽量短小
  • 一个函数应该只做一件事,只在一个对象层进行操作
  • 让代码拥有自顶向下的阅读顺序
  • 使用描述性的名称,命名方式要保持一致
  • 函数参数越少越好
  • 函数参数多就要考虑封装成类了