14、让代码更易读的实用技巧

让代码更易读的实用技巧

1. 让代码自解释

有时代码需要注释来解释其功能，例如下面这个生成用户 ID 的代码：

String generateId(String[] data) {
  // data[0] contains the user's first name, and data[1] contains the user's 
  // last name. Produces an ID in the form "{first name}.{last name}".
  return data[0] + "." + data[1];
}

这里的注释是因为代码本身不够清晰。更好的做法是让代码更具可读性，可使用命名良好的辅助函数：

String generateId(String[] data) {
  return firstName(data) + "." + lastName(data);
}
String firstName(String[] data) {
  return data[0];
}
String lastName(String[] data) {
  return data[1];
}

让代码自解释通常比使用注释更好，因为它减少了维护开销，也避免了注释过时的问题。

2. 合理使用注释

注释在很多场景下非常有用：
- 解释代码存在的原因 ：有些代码的实现原因可能与特定的上下文