12、让代码更具可读性的实用技巧

让代码更具可读性的实用技巧

在软件开发中，编写易读的代码是一项至关重要的技能。易读的代码不仅能让开发者快速准确地理解代码的功能，还能降低维护成本，减少出错的可能性。本文将介绍一些常见且有效的让代码更具可读性的技巧。

1. 使用描述性名称

名称在代码中用于唯一标识类、函数和变量等元素，同时也能简要概括其用途。就像“toaster”这个词，它不仅唯一标识了厨房中的一种电器，还清晰地表明了其功能——烤东西。在代码中，使用描述性名称同样重要。

1.1 非描述性名称让代码难以阅读

以下是一个极端的例子，展示了如果不使用描述性名称，代码会变得多么难以理解：

class T {
  Set<String> pns = new Set();
  Int s = 0;
  ...
  Boolean f(String n) {
    return pns.contains(n);
  }

  Int getS() {
    return s;
  }
}

Int? s(List<T> ts, String n) {
  for (T t in ts) {
    if (t.f(n)) {
      return t.getS();
    }
  }
  return null;
}

在没有额外信息的情况下，很难理解这段代码的具体功能以及其中的字符串、整数和类所代表的概念。

1.2 注释不能替代描述性名称

为了改善代码的可读性，可能会想到添加注释和文档。以下是添加注释后的代码： <