코드 스타일링 & 가독성

우리가 작성하는 코드는 보통 대부분 우리만 보는 코드가 아니다.

항상 팀 단위의 개발자인 경우 다수가 코드를 보게 되는 경우가 많은데, 작성한 코드를 이해 못하는 경우가 발생할 수가 있다.

혹은 다른 사람이 아니어도 미래의 내가 과거에 작성했던 코드를 이해 못 하는 경우도 있을 수 있다.

그렇기에 우리는 알아보기 쉬운 코드를 작성할 필요가 있다.

 

모두가 알아보기 쉽게 적을 수 있도록 공식적으로 스타일링 가이드도 제공되어 있다.

그 중 우리는 몇 가지 중요하고 기본적인 코드 스타일링들을 살펴보자.

*보통 일하는 곳마다 컨벤션이 조금씩 차이가 있을 수 있지만, 현재 일하고 있는 기업의 컨벤션을 따르는 것이 가장 좋다.

 

1. Indentation - 들여쓰기

- 새로운 블록이 생성될 때마다 기본 +2칸을 의미한다.

 

2. Naming - 변수명, 함수명

- 변수 할당 값이 Class인 경우에 주로 변수의 첫 글자를 대문자로 사용한다.

- 상수는 모두 대문자로 적는다.

 

3. 기호 및 구두점 (Punctuation)

- Javascript의 문자열 표시를 위해서 작은 따옴표를 권장한다.

- 줄 바꿈이 필요한 문자열을 정의할 때는 `(백틱, backtick) 사용을 권장한다.

- 함수 표현식의 끝에는 세미콜론을 사용한다.

 

4. 연산자와 키워드

- 엄격한 비교 연산자 : 엄격한 동치 연산 (Strict equality, ===, !==)을 사용한다.

- 느슨한 동치 연산 (Loose equality : ==, !=) 사용을 비추한다.

 

5. 짧게 쓰기

- 코드는 뜻이 분명하고 실행 되는 한, 되도록 짧게 쓰길 권장한다.

- 예시로, 부정의 의미가 명확한 곳에만 NOT 연산자(!) 사용을 하거나 Boolean으로 평가되는 표현문은 바로 return 하는 것을 권장한다.

 

6. 코드 문장과 구문 사이 공간

- 줄 바꿈은 최소로 사용하고, 블록 사이의 들여쓰기 또한 일관성 있게 쓰기를 권장한다.

 

7. 주석

- 꼭 필요한 경우에만 작성한다. (주석이 많으면 가독성을 떨어트린다.)

 

8. camelCase vs. snake_case

- 변수의 이름을 지정할 때 'Camel Casing'으로 지정한다.

 

위에 간단하게 정리한 것들 이외에 무수한 스타일 가이드들이 있다.

단지.. 이 공식 사이트의 가이드는 한국어 번역이 기본 제공되어 있지 않은 점.. 

추후 참고하면서 프로그래밍 하면 도움이 많이 될 것 같다.