코딩 스타일 Part 1. 이름 짓기 - Javascript

1) Variable names - 변수의 이름

 

: 변수의 이름은 하나의 단어로 표현하는 것이 가장 좋다. 본인이 다루고 있는 문제의 영역, 핵심을 잘 묘사해주는 단어일수록 좋다. 또한, 구조적인 부분보다 변수의 목적을 고려하여 이름을 지어야 한다.

 

예)

Good : var animals = ['cat', 'dog', 'fish'];

Bad : var targetInputs = ['cat', 'dog', 'fish'];

 

2) Boolean names - Boolean 이름

 

: Boolean에 관한 변수의 이름은 전형적인 형식을 가진다. Boolean 값은 참 또는 거짓이므로, 관련 변수의 이름 앞에 "is" 혹은 "are"을 붙인다.

 

예)

"isValid" 또는 "areAvialable"

 

3) Function names - 함수 이름 짓기

 

: 함수 관련 변수의 이름을 지을 때는 동사로 시작해야 한다. 예를 들면 calculate Total 혹은 listInventory 등 "{verbObject}"와 같은 형식이다. 이런 형식을 사용하면, 변수 이름의 의미가 뚜렷해진다. 또 code를 빠르게 훑어보는 사람들이 함수의 입력값과 출력값, 그리고 둘 사이의 변환 과정을 파악하기가 쉬워진다.

 

예)

 

Bad : var waterBlocks = function() { // count how many blocks of ater are collected between each tower }

Good : var countWaterBlocks = function() { // do stuff }

 

4) Capital letters in variable names - 변수 이름에서의 대문자

 

• 대부분의 사람들은 변수가 포함한 "class"를 지시하기 위해 변수 이름의 첫 글자를 대문자로 쓴다.
• 몇몇 사람들은 "new" 키워드를 사용한 함수에 한해서 대문자를 쓰기도 한다.
• 상수(constant), 즉 프로그램 전체에서 일정한 값을 가지는 변수의 이름을 정할 때는 그 변수의 이름은 전체를 대문자로 쓴다.

// Example of a capitalized class constructor function name.
function Animal() {
}
// Example of an all-caps constant variable name.
const MAX_ITEMS_IN_QUEUE = 100;