코드 작성법 / 코드 스타일링
코드 스타일링의 중요성
Indentation
들여쓰기를 할때 탭이 아닌 2개의 스페이스를 권장한다.
절.대.로! 스페이스와 탭을 혼용해서 쓰면 안된다.
Naming
- 변수명은 값의 본질적인 의미를 가지고 있어야 된다.
- 변수의 이름은 한단어(Descriptive word)로 표현하는 것이 가장 좋다.- 변수에 할당되는 값의 형식이 아닌, 값의 의미가 변수 이름에 반영되어야 한다.
- 데이터 모음(collection)이 할당된 변수 이름은 복수 명사가 좋다.
- Boolean이 할당된 변수는
is / are
을 붙여 참 혹은 거짓임을 분명히 표현한다.- 함수의 이름은 동사로 시작하는 것이 좋다.
- 함수의 기능을 담은 동사를 함수명에 포함하면 역할을 쉽게 파악할 수 있다.- 변수 할당 값이 Class인 경우에 주로 변수의 첫 글자를 대문자로 사용한다.
- 상수는 모두 대문자로 적는다.
Punctuation
- 문법적으로 생략 가능한 때에도 중괄호는 생략하지 않는다.
- JavaScript의 문자열 표시를 위해서 작은 따옴표를 권장.
- HTML에서 사용하는 큰 따옴표와 구분하기 위해- 줄 바꿈이 필요한 문자열을 정의할 때는 `(백틱, backtick) 사용
- 코드 실행의 가장 작은 단위인 Statement(문)의 끝에 세미콜론을 사용
- if, for, while문의 끝에는 세미콜론을 사용하지 말 것
- 함수 표현식의 끝에는 세미콜론을 사용.
연산자와 키워드
- 엄격한 비교 연산자를 사용하세요.(=== / !==)
- 3항 연산자
?
는 간결하고 가독성이 좋은 경우만 사용한다.- not 연산자
!
는 바로 앞에 붙여 사용
짧게 쓰기
- 코드는 뜻이 분명하고 실행되는 한, 되도록 짧게 쓴다.
- 부정의 의미가 명확한 곳에만 NOT 연산자 사용
- Boolean으로 평가되는 표현문은 바로 리턴
코드 문장과 구문 사이 공간
- 한번에 더 많은 코드를 읽기 위해, 줄 바꿈 최소로 사용
- 들여쓰기는 일관성 있게, 최소화하여 사용
- 같은 라인에 값을 보기 위해 하는 들여쓰기 지양
- 콤마
,
사이는 한 칸 띄어씁니다.- 연산자 사이는 한 칸 띄어씁니다.
주석
- 주석은 필요한 경우에만 작성
- 주석을 적기 전, 변수 이름과 구조로 코드 목적이 명확히 표현되면 주석을 적을 필요 없다.
- 주석으로 코드의 작동을 설명하는 것은 지양한다.
- 주석을 공부 목적으로 활용하는 것은 좋으나, 점차 줄여나가자.
camelCase vs. snamke_case
JS에서는 변수의 이름을 지정할때 'Camel Casing'으로 지정한다.
유명한 코드 스타일 가이드