코드 스타일링

Judo·2020년 11월 10일
0
post-thumbnail
post-custom-banner

코드 스타일링 : 가독성 좋은 코드를 작성하는 것.

들여쓰기(Indentation)

  • 2개의 스페이스로 들여쓰기 하기를 권장
  • tap키와 스페이스 키를 혼용하지 말 것

이름 짓기(Naming)

  • 변수명은 값의 본질적인 의미를 가지고 있어야 한다.
  • 변수에 할당되는 값의 형식이 아닌, 그 값의 의미가 변수 이름에 반영되어야 한다.
  • 데이터의 모음이 할당된 별수의 이름은 복수 명사로 한다.
  • boolean이 할당된 변수는 is 혹응 are을 붙여서 참 혹은 거짓임을 표현한다.
  • 함수의 이름은 동사로 시작한다.
  • 변수 할당 값이 class인 경우에 주로 변수의 첫 글자를 대문자로 사용한다.
  • 상수는 모두 대문자로 적는다.

기호 및 구두점(punctuation)

  • 문법적으로 생략 가능한 때에도 중괄호는 생략하지 않는다.
  • JavaScript의 문자열 표시를 위해 작은 따옴표를 권장한다.
  • 줄 바꿈이 필요한 문자열을 정의할 때는 \n 이 아니라 백틱을 권장한다.
  • 코드 실행의 가장 작은 단위인 Statement(문)의 끝에 세미콜론을 사용한다.
  • if,for,while문의 끝에는 세미콜론을 사용하지 않는다.
  • 함수 표현식 끝에는 세미콜론을 권장한다.

연산자와 키워드

  • 엄격한 비교 연산자를 사용한다.
  • 3항 연산자(?)는 간결하고 가독성이 좋은 경우만 사용한다.
  • not 연산자(!)는 바로 앞에 붙여서 사용한다.

짧게 쓰기

  • 코드는 뜻이 분명하고 실행 되는 한, 되도록 짧게 쓴다.
  • 부정의 의미가 명확한 곳에만 NOT 연산자를 사용한다.
  • Boolean으로 평가되는 표현문은 바로 return 한다.

코드 문장과 구문 사이 공간

  • 한 번에 더 많은 코드를 읽기 위해서, 줄 바꿈은 최소로 사용한다.
    * 줄 바꿈 판단 기준은 이해하기 쉽게 하는 방향이다.
  • 들여쓰기는 일관성있게, 최소화하여 사용한다.
  • 같은 라인에 값을 보기 위해 하는 들여쓰기는 지양한다.
  • 콤마(,) 사이는 한 칸 띄어쓴다.
  • 연산자 사이는 한 칸 띄어쓴다.

주석

  • 주석은 꼭 필요한 경우에만 작성한다.
  • 주석으로 코드의 작동을 설명하기보단, 코드를 보고 바로 이해할 수 있을 만큼 가독성이 좋게 코드를 작성한다.

camelCase vs snake_case

  • JavaScript 에서 변수의 이름을 지정할 때 Camel Casing으로 지정한다.
  • Javascript 에서 뱀 모양을 사용하는 경우는, 상수 이름을 지을 때
profile
즐거운 코딩
post-custom-banner

0개의 댓글