가독성 좋은 코드를 작성하는 것

가독성이 떨어지면

• 동료가 이해 X → 소통에 걸리는 시간 증가
• 코드에 에러가 있는 경우 쉽게 발견 X

Indentation

Good:

if (condition) {
  action();
}
// 코드의 로직이 명확하게 종속적으로 나뉘는 코드를 쓸 때, 종속된 code block는 주인 code block보다 두 칸 들여쓰기 합니다.

Bad:

if (condition) {
action();
}

들여쓰기를 할 때 탭이 아닌 스페이스를 권장합니다.

들여쓰기와 관련된 탭과 스페이스 사이의 논쟁은 프로그래밍 세계에서는 아주 오래된 논쟁입니다. 그렇기에 취향의 차이일 뿐 이것이 맞다 틀리다의 문제는 아니지만, 많은 JavaScript 프로젝트에서 대부분의 프로젝트가 2개의 스페이스를 쓰고 있고, 점차 들여쓰기 논쟁의 승리자가 되었습니다. 다수의 오픈소스 프로젝트가 진행중인 GitHub에서는, Star(일종의 '좋아요')를 받은 프로젝트의 85% 이상의 JavaScript 프로젝트가 스페이스 들여쓰기를 사용하고 있습니다.

여러분이 절대로 피해야 할 단 한가지는, 바로 스페이스와 탭을 혼용해서 쓰는 것입니다!

Good:

if (condition) {
  action();
}
// code block의 마지막 줄을 쓸 때 마지막 줄의 시작은, 시작할 때 줄의 시작과 동일한 곳에서 해주세요.

Bad:

if (condition) {
  action();
  }
// 종속된 code block의 시작에 맞추면 안됩니다.

Bad:

transmogrify({
   a: {
    b: function(){
    }
}});
// code block이 바뀌고 해당 code block에 맞춰 줄을 바꿀 때 2칸 들여쓰기 규칙을 지켜야 합니다.
// 속성 a 안에 속성 b가 있는데, 마치 같은 범주에 있는 속성으로 보입니다. 또한 함수와 객체의 구분이 명확하지 않습니다.

Naming