코드 가독성이란?

코드의 가독성을 높이려면, 먼저 코드의 목적이 뚜렷하고 자명해야 합니다. 그리고 그 구조가 일관되고 예측 가능해야 합니다.

구조의 일관성이 부족한 코드일수록, 그런 코드를 해석하기 위해서는 더 많은 노력이 필요합니다. 왜냐하면 코드를 읽을 때 우리는 코드의 구조가 그 코드의 실제 뜻과 연관되어 있을 것이라 가정하고 해석하기 때문입니다. 종종 그런 해석이 어려운 코드를 읽는 사람이 당신일 수 있습니다. 면접자리에서 자신이 만들어낸 어려운 코드를 해석하기 위해 씨름하는 것은 정말 슬픈 일입니다. 해석하기 어려운 코드는 쓰지 마세요!

아래 가이드라인을 잘 따라서 코딩한다면 당신은 해석하기 쉬운 코드를 쓸 수 있게 될 거에요.

Indentation – 들여쓰기

논리적으로 종속되어 있는 코드를 쓸 때, 종속된 code block는 주인 code block보다 두 칸 들여쓰기 합니다.

들여쓰기를 할 때 탭이 아닌 스페이스를 사용하세요. 탭은 안됩니다.

들여쓰기와 관련된 탭과 스페이스 사이의 논쟁은 프로그래밍 세계에서는 아주 오래된 논쟁입니다. 그렇기에 취향의 차이일 뿐 이것이 맞다 틀리다의 문제는 아닙니다. 그러나, 많은 JavaScript 프로젝트에서 대부분의 프로젝트가 2개의 스페이스를 쓰고 있고, 점차 들여쓰기 논쟁의 승리자가 되었습니다. 들여쓰기 약속은 프로그래밍 언어마다 조금씩 다릅니다. 다수의 오픈소스 프로젝트가 진행중인 GitHub에서는, Star(일종의 '좋아요')를 받은 프로젝트의 85% 이상의 JavaScript 프로젝트가 스페이스 들여쓰기를 사용하고 있습니다.여러분이 절대로 피해야 할 단 한가지가 있다면, 바로 스페이스와 탭을 혼용해서 쓰는 것입니다. 이것은 금기입니다!

새로운 code block를 시작할 때면 이전 code block보다 2칸 더 들여쓰기 후 코드를 쓰기 시작하세요

Good:

if (condition) {
  action();
}

Bad:

if (condition) {
action();
}

Code block의 마지막 줄을 쓸 때 마지막 줄의 시작은, 시작할 때 줄의 시작과 동일한 곳에서 해주세요. 종속된 code block의 시작에 맞추면 안됩니다.

Good:

if (condition) {
  action();
}

Bad: