加入收藏 | 设为首页 | 会员中心 | 我要投稿 西安站长网 (https://www.029zz.com.cn/)- 科技、建站、经验、云计算、5G、大数据,站长网!
当前位置: 首页 > 移动 > 正文

阿里工程师谈什么是好的代码?

发布时间:2019-08-30 01:56:40 所属栏目:移动 来源:佚名
导读:副标题#e# 一句话概括 衡量代码质量的唯一有效标准:WTF/min Robert C. Martin Bob 大叔对于好代码的理解非常有趣,对我也有很大的启发。我们编写的代码,除了用于机器执行产生我们预期的效果以外,更多的时候是给人读的,这个读代码的可能是后来的维护人员

如果去掉了空行,可读性大大降低。

  1. public class Demo { 
  2.      @Resource 
  3.      private List<Handler> handlerList; 
  4.      private Map<TypeEnum, Handler> handlerMap = new ConcurrentHashMap<>(); 
  5.      @PostConstruct 
  6.      private void init() { 
  7.          if (!CollectionUtils.isEmpty(handlerList)) { 
  8.              for (Handler handler : handlerList) { 
  9.                  handlerMap.put(handler.getType(), handler); } } } 
  10.      public Result<Map<String, Object>> query(Long id, TypeEnum typeEnum) { 
  11.          Handler handler = handlerMap.get(typeEnum); 
  12.          if (null == handler) { 
  13.              return Result.returnFailed(ErrorCode.CAN_NOT_HANDLE); 
  14.          } 
  15.          return handler.query(id); } 
  16.  } 

类静态变量、实体变量应定义在类的顶部。类内方法定义顺序依次是:公有方法或保护方法 > 私有方法 > getter/setter 方法。

水平格式

要有适当的缩进和空格。

团队统一

通常,同一个团队的风格尽量保持一致。集团对于 Java 开发进行了非常详细的规范。(可点击下方阅读原文,了解更多内容)

类与函数

类和函数应短小,更短小

类和函数都不应该过长(集团要求函数长度最多不能超过 80 行),过长的函数可读性一定差,往往也包含了大量重复的代码。

函数只做一件事(同一层次的事)

同一个函数的每条执行语句应该是统一层次的抽象。例如,我们经常会写一个函数需要给某个 DTO 赋值,然后再调用接口,接着返回结果。那么这个函数应该包含三步:DTO 赋值,调用接口,处理结果。如果函数中还包含了 DTO 赋值的具体操作,那么说明此函数的执行语句并不是在同一层次的抽象。

参数越少越好

参数越多的函数,调用时越麻烦。尽量保持参数数量足够少,最好是没有。

注释

别给糟糕的代码加注释,重构他

注释不能美化糟糕的代码。当企图使用注释前,先考虑是否可以通过调整结构,命名等操作,消除写注释的必要,往往这样做之后注释就多余了。

好的注释提供信息、表达意图、阐释、警告

(编辑:西安站长网)

【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容!

热点阅读