代码可读性不是审美问题:三个能立刻改的习惯

举报
yd_222029404 发表于 2026/11/04 09:33:11 2026/11/04
【摘要】 命名、函数长度、提前返回——这三件事改动成本最低,但对后续维护者的影响最大。附可直接照抄的改法。

一、命名要说明「是什么」,不要说明「怎么做」

看到 getUserListFromDbAndCache 这样的函数名,你会先猜它有没有副作用。listUsers 就干净得多——做什么一目了然,怎么实现属于细节,改实现时名字也不用改。

两个实用规则:

  • 布尔值用 is/has/can/should 开头,读起来像一句话:if (hasPermission) {}
  • 避免 data、info、handle 这类空词,它们只占位置不传递信息

二、函数长度不是硬指标,嵌套深度才是

把一个 200 行的函数砍成三个 60 行的函数,如果只是机械切割,可读性并不会变好。真正影响阅读的是嵌套层数:三层 if 里再套一层循环,读者需要在脑子里同时维护四个条件。

最有效的做法是提前返回(guard clause):

// before
function save(user) {
  if (user) {
    if (user.active) {
      if (user.email) {
        return db.write(user);
      }
    }
  }
}

// after
function save(user) {
  if (!user) return;
  if (!user.active) return;
  if (!user.email) return;
  return db.write(user);
}

行数变多了,但每一行都不需要上下文就能读懂。

三、把「为什么」写成注释,「是什么」交给代码

// 把 count 加一 这种注释是在复述代码,属于噪音。有价值的注释是解释为什么这么做:为什么这里要重试三次、为什么这个字段允许为空、为什么不能用更直观的那写法。

一个判断标准:如果注释删掉后,下一个人可能会「优化」掉这段代码,那这条注释就该留。

小结

可读性提升不靠大重构。先改命名、再用提前返回压掉嵌套、最后只保留解释「为什么」的注释——这三步几乎不改变行为,却能让 review 和排障的成本显著下降。

【声明】本内容来自华为云开发者社区博主,不代表华为云及华为云开发者社区的观点和立场。转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息,否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0)

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。