格式化

格式化是主观的。 就像其它规则一样， 没有必须让你遵守的硬性规则。 重点是不要因为格式去争论， 这
里有大量的工具来自动格式化， 使用其中的一个即可！ 因
为做为工程师去争论格式化就是在浪费时间和金钱。

针对自动格式化工具不能涵盖的问题（缩进、 制表符还是空格、 双引号还是单引号等）， 这里有一些指南。

使用一致的大小写

JavaScript 是无类型的， 所以大小写告诉你关于你的变量、 函数等的很多事情。 这些规则是主观的，
所以你的团队可以选择他们想要的。 重点是， 不管你们选择了什么， 要保持一致。

不好的：

  1. const DAYS_IN_WEEK = 7;
  2. const daysInMonth = 30;
  4. const songs = ['Back In Black', 'Stairway to Heaven', 'Hey Jude'];
  5. const Artists = ['ACDC', 'Led Zeppelin', 'The Beatles'];
  7. function eraseDatabase() {}
  8. function restore_database() {}
  10. class animal {}
  11. class Alpaca {}

好的：

  1. const DAYS_IN_WEEK = 7;
  2. const DAYS_IN_MONTH = 30;
  4. const songs = ['Back In Black', 'Stairway to Heaven', 'Hey Jude'];
  5. const artists = ['ACDC', 'Led Zeppelin', 'The Beatles'];
  7. function eraseDatabase() {}
  8. function restoreDatabase() {}
  10. class Animal {}
  11. class Alpaca {}

函数的调用方与被调用方应该靠近

如果一个函数调用另一个， 则在代码中这两个函数的竖直位置应该靠近。 理想情况下，保持被调用函数在被
调用函数的正上方。 我们倾向于从上到下阅读代码， 就像读一章报纸。 由于这个原因， 保持你的代码可
以按照这种方式阅读。

不好的：

  1. class PerformanceReview {
  2.   constructor(employee) {
  3.     this.employee = employee;
  4.   }
  6.   lookupPeers() {
  7.     return db.lookup(this.employee, 'peers');
  8.   }
  10.   lookupManager() {
  11.     return db.lookup(this.employee, 'manager');
  12.   }
  14.   getPeerReviews() {
  15.     const peers = this.lookupPeers();
  16.     // ...
  17.   }
  19.   perfReview() {
  20.     this.getPeerReviews();
  21.     this.getManagerReview();
  22.     this.getSelfReview();
  23.   }
  25.   getManagerReview() {
  26.     const manager = this.lookupManager();
  27.   }
  29.   getSelfReview() {
  30.     // ...
  31.   }
  32. }
  34. const review = new PerformanceReview(user);
  35. review.perfReview();

好的：

  1. class PerformanceReview {
  2.   constructor(employee) {
  3.     this.employee = employee;
  4.   }
  6.   perfReview() {
  7.     this.getPeerReviews();
  8.     this.getManagerReview();
  9.     this.getSelfReview();
  10.   }
  12.   getPeerReviews() {
  13.     const peers = this.lookupPeers();
  14.     // ...
  15.   }
  17.   lookupPeers() {
  18.     return db.lookup(this.employee, 'peers');
  19.   }
  21.   getManagerReview() {
  22.     const manager = this.lookupManager();
  23.   }
  25.   lookupManager() {
  26.     return db.lookup(this.employee, 'manager');
  27.   }
  29.   getSelfReview() {
  30.     // ...
  31.   }
  32. }
  34. const review = new PerformanceReview(employee);
  35. review.perfReview();