자바스크립트 코딩 컨벤션
Q. 작성 이유:
코드의 가독성을 높이고 작성한 코드를 효율적으로 유지 보수하기 위해서 공통의 규칙으로 작성합니다.
코딩 컨벤션은 자바스크립트 뿐만 아니라, 모든 언어들에 해당하는 내용입니다.
코드를 작성할 때 문법에 맞게 코딩하는 것도 중요합니다. 하지만 작성한 코드에서 무언가를 수정하려 할 때 혹은 동료와 협업을 하는 경우에 복잡하게 작성된 코드를 보게되면 나도 알아보기 힘들고 동료는 한숨부터 나오겠죠?...
이때 공통된 규칙이 있다면, 그리고 그러한 규칙으로 코드를 작성한다면 작성된 코드를 유지보수 할 때 한숨쉬지 않고 효율적으로 관리 할 수 있습니다!!
그렇다면 자바스크립트에서는 어떠한 코딩 컨벤션(=스타일 가이드)으로 작성하면 효율적인지 살펴보겠습니다.
Q. 규칙은 누가 정할까?
코딩 컨벤션에 맞게 작성하는 것이 강제는 아니므로, 정의 내리는 주체에 따라 다릅니다.
만약 저와 제친구 익명이 둘이 코드를 작성한다면, 둘만의 의견을 수용하여 코드를 작성하면 됩니다.
하지만, 코드를 작성하는 집단의 규모는 다 다르고 사람마다 스타일도 다르겠죠??
보통은 구글이나 에어비엔비에서 배포한 것을 기준으로 작성합니다.
규칙
- 코드를 보기 좋게 들여쓰기 합니다.
: 들여쓰기를 해서 작성하면 소스 간의 포함 관계를 알아보기가 쉽습니다.
공백이 2칸 이거나 4칸인 들여쓰기를 권장합니다.
공백 4개는 화면을 많이 차지하므로 최근에는 공백 2칸 들여쓰기를 많이 사용한다고 합니다.
- 세미콜론으로 문장을 구분합니다.
: 자바스크립트는 세미콜론(;)을 붙이지 않아도 실행됩니다.
하지만 코딩 컨벤션에서는 문장을 끝낼 때 반드시 세미콜론을 붙이도록 권장합니다.
이렇게 문장을 명확하게 표시해 주면 소스를 디버깅하기 쉽기 때문입니다.
또한 소스는 한 줄에 한 문장만 작성하는 것을 권장합니다.
- 공백을 넣어 읽기 쉽게 작성합니다.
: 예약어나 연산자, 값 사이에는 공백을 넣어서 소스 코드를 읽기 쉽게 작성하는 것을 권장합니다.
공백이 없어도 잘 실행되지만, 실제로 개발자가 소스 코드를 읽거나 디버깅을 할 때는 공백이 있어야 가독성이 좋습니다.
- 소스 코드를 잘 설명하는 주석을 작성합니다.
: 프로그래밍의 주석은 소스 코드를 살펴보기 위해 꼭 필요한 요소입니다.
참고로, "개발자는 코드보다 주석을 더 많이 작성할 것이다." 라는 말도 존재합니다.
주석은 2가지 형태로 작성이 가능합니다.
- 한 줄 주석: //
- 여러 줄 주석: /* */
- 식별자는 정해진 규칙을 지켜 작성합니다.
: 식별자란 개발자가 변수, 함수, 속성 등을 구별하려고 이름 붙인 특정 단어를 의미합니다. (즉, 이름 짓기 나름이죠!! 하지만 필수적인 규칙은 존재합니다..)
식별자의 첫 글자는 반드시 영문자나 언더스코어(), 또는 달러 기호($)로 시작해야 합니다.
하나의 식별자를 만들 경우 단어 사이에 공백을 둘 수 없고, 단어와 단어 사이를 하이픈(-)이나 언더바()로 연결해서 사용합니다.
또는 카멜케이스로도 작성이 가능합니다.
그리고 필수가 아닌 규칙으로는 의미가 명확한 네이밍을 하는 것을 권장합니다.
만약 나만 알아봐야지 ㅎㅎㅎ 하면서 의미불명의 네이밍을 한다면... 저라면 같이 일하기 싫을 것 같습니다!!...
- 예약어는 식별자로 사용할 수 없습니다.
: 예약어는 키워드라고도 하는데, 식별자로 사용할 수 없도록 자바스크립트에 미리 정해 놓은 단어를 가리킵니다.
예를 들어 var는 변수를 선언할 때 쓰는 예약어이며, 식별자 이름으로는 사용할 수 없습니다.
