JavaScript 스타일 가이드 - Blocks

원문:https://github.com/airbnb/javascript

• 복수행 블록은 중괄호 ({})를 사용하자.
  

  // bad
  if (test)
    return false;
  
  // good
  if (test) return false;
  
  // good
  if (test) {
    return false;
  }
  
  // bad
  function() { return false; }
  
  // good
  function() {
    return false;
  }

Comments 원문

• 복수행의 코멘트는 /** ... */ 를 사용하자. 그 안에는 설명과 모든 매개 변수와 반환 값에 대한 형식과 값을 설명한다.

  // bad
  // make() returns a new element
  // based on the passed in tag name
  //
  // @param <String> tag
  // @return <Element> element
  function make(tag) {
  
    // ...stuff...
  
    return element;
  }
  
  // good
  /**
   * make() returns a new element
   * based on the passed in tag name
   *
   * @param <String> tag
   * @return <Element> element
   */
  function make(tag) {
  
    // ...stuff...
  
    return element;
  }
  

• 한 줄 주석에는//를 사용하자. 코멘트를 추가하고 싶은 코드의 상단에 작성하자. 또한 주석 앞에 빈 줄을 넣어주자.

  // bad
  var active = true;  // is current tab
  
  // good
  // is current tab
  var active = true;
  
  // bad
  function getType() {
    console.log('fetching type...');
    // set the default type to 'no type'
    var type = this._type || 'no type';
  
    return type;
  }
  
  // good
  function getType() {
    console.log('fetching type...');
  
    // set the default type to 'no type'
    var type = this._type || 'no type';
  
    return type;
  }
  

• 문제를 지적하고 재고를 촉구하거나 문제에 대한 해결책을 제시하는 등 의견의 앞에 FIXME 나 TODO를 붙이는 것으로 다른 개발자의 빠른 이해를 도울 수 있다. 이러한 어떤 액션을 동반한다는 의미에서 일반 코멘트와는 다르다. 액션은 FIXME - 해결책이 필요 또는 TODO - 구현이 필요 니다.
• 문제에 대한 코멘트로 // FIXME :를 사용하자.

  function Calculator() {
  
    // FIXME: 전역 변수를 사용해서는 안됩니다.
    total = 0;
  
    return this;
  }
  

• 문제 해결책에 대한 코멘트로 // TODO :를 사용하자.

  function Calculator() {
  
    // TODO: total은 옵션 매개 변수로 설정되어야 함.
    this.total = 0;
    return this;
  }