JavaScript

javascript 코드 스타일링(a.k.a. 코드 가독성 높이는 법)

노프Nope 2021. 5. 19. 23:40

목적

커뮤니케이션 비용을 줄인다.

원칙

절대적인 스타일링은 없지만, 혼용은 최악이다.


들여쓰기

  • 자바스크립트에서는 2개의 스페이스 로 indentation(들여쓰기)를 하는 것이 지금의 대세다.
  • 가독성을 고려하되, 최소화하여 사용한다.
  • 논리적으로 구분되는 단락에는 세로 들여쓰기(빈 줄 삽입) 를 한다.

변수명 짓기

  • 가능한 업계 용어 를 그대로 쓰는 것이 좋다. (본인이 속한 회사가 속한 산업 분야)
  • 저장할 값의 내용 을 담아야 한다. (형식이 아닌)
  • boolean타입이 할당된 변수는 is/are 등의 be동사를 사용해 직관적으로 나타낸다.
  • class를 할당할 경우 첫 글자를 대문자 로 한다.

상수명

  • 대문자 로 적는다.
  • Snake Casing 으로 짓는다.
    예: const THIS_IS_WHAT = 'SNAKE_CASING_LOOKS_LIKE';

구두점

  • 문자열 표기 시 작은 따옴표('') 를 권장한다.
  • 줄 바꿈이 필요한 문자열은 백틱(`) 으로 표시한다.
  • if, for, while문 의 끝(}중괄호 뒤)에는 세미콜론(;)을 사용하지 않는다.
  • 함수 표현식 의 끝에는 동일하게 중괄호가 있더라도 세미콜론(;)을 사용한다.
  • (,) 사이에는 공백(space)을 준다.

연산자

  • 3항 연산자('?')는 가독성이 좋을 때만 사용한다.
  • 연산자 사이에는 공백(space)을 준다.

짧게 쓰기

  • boolean으로 평가되는 표현문은 조건문을 사용하지 않고 바로 리턴 한다.

Linter

  • 자동으로 코딩 스타일을 체크해주는 도구
  • 플러그인 형태로 에디터에 설치해 사용할 수 있다.

참고: 코드스테이츠 유어클래스
코어 자바스크립트 - 코딩 스타일