[개발 규칙] Javascript 코딩컨벤션

공통 규칙

1. 들여쓰기: 보통 2칸 스페이스를 사용

2. 각 줄은 80자 또는 100자로 제한

3. 모듈 레벨 함수 및 클래스 정의는 두줄 간격으로 작성

4. 괄호, 중괄호, 대괄호 내부에는 공백 사용 금지

5. 쉼표, 콜론, 세미콜론 앞에 공백 사용 금지. 뒤에는 공백 사용

6. 주석은 한 줄의 경우 //을 사용하고 코드와 두칸의 공백을 둠. 여러 줄의 경우 /** ~ */을 사용

7. docstring 작성시 JSDoc을 사용.

/** 
* Adds two numbers together. 
* @param {number} a - The first number. 
* @param {number} b - The second number. 
* @return {number} The sum of the two numbers. 
*/ 
function add(a, b) { 
	return a + b; 
}

 

변수 및 함수

1. 변수 및 함수명은 CamelCase로 작성

2. 변수 선언시 var 대신 const, let 사용

3. 상수는 영어대문자 및 밑줄(_)로 작성. 모듈 수준에서만 작성.

4. 문자열의 경우 쌍따옴표(")를 사용

5. 템플릿 리터럴의 경우 백틱(`)을 사용

6. 연산자 앞뒤에 공백 사용

7.  값 비교시 == 대신 ===을 사용하여 형변환 없이 비교

8. 함수의 docstring은 함수에 대한 설명, args, return에 대한 설명을 포함

9. 함수는 함수표현식을 사용하여 변수에 할당

10. 화살표 함수는 콜백이나 익명함수시 사용

10. 글로벌 변수의 경우 모듈내에서만 사용하고 g_로 시작

 

클래스

1. 클래스명은 PascalCase로 작성

2. 클래스 상속시, 상위부모부터 순서대로 작성.

3. 클래스내 메서드는 한줄 간격으로 작성.

4. 메서드명은 CamelCase로 작성

5. private의 경우 두 개의 밑줄(__)로 시작

6. protected의 경우 한 개의 밑줄(_)로 시작

7. 클래스 정의시 생성자와 소멸자

8. 객체나 배열을 다룰 때는 비구조화 할당을 사용

9. 열이나 객체를 복사하거나 병합할 때 스프레드 연산자를 사용

모듈 및 패키지

1. 각 패키지 및 모듈은 별도의 줄에 작성

2. 표준 라이브러리, 서드 파티 모듈, 로컬 모듈 순서로 작성

3. 모듈명은 영어 소문자로 작성

4. ES6의 import와 export 사용

import {function} from './module.js'