Skip to content

Code Convention

황주희 edited this page Jan 29, 2023 · 1 revision

Lint

  • 세미콜론 필수
  • function으로 함수 작성이 기본, 필요할 때 화살표 함수 사용합니다.
  • 상대 경로로 import, export합니다.
  • export할 함수는 function을 사용합니다.
  • var를 쓰지 않고, const와 let을 사용합니다.
  • sign in sign up 단어는 두개의 단어로 생각하여 카멜케이스를 사용할 때 signIn signUp으로 사용합니다.
  • 서버요청 관련 코드에서는 무조건 status값을 받아 체크해주고 try catch문으로 묶어줍니다.

Tap Depth

  • 기본 tap depth는 2, 최대 tap depth는 4
  • depth가 4 이상으로 깊어지면 함수를 통해 나눌 수 있도록 합니다.

Naming

  • 변수, 함수, 객체, 패키지명 등 기본적으로 camelCase를 사용합니다.
  • js 파일명도 camelCase로 작성합니다.
  • 상수명은 SCREAM_SNAKE_CASE를 사용합니다.
  • 클래스나 생성자명은 PascalCase를 사용합니다.
  • image, svg는 단어 사이 공백에 -를 사용합니다. (ex. erase-check.svg)
  • 이름을 통해 쓰임새를 알 수 있도록 합니다. (20자 미만, 직관적이게)
  • 이름의 맨 앞이나 맨 뒤에 언더바(_)를 사용하지 않습니다.
  • 이벤트 핸들러는 on + 메소드명 + Handler로 작성합니다.
  • 함수 이름은 동사+명사 구조로 네이밍합니다.

Comment

**// 기본 주석**

**// ?** 의견을 묻는 주석 예시입니다.
  의견을 구해야하거나, 피드백을 구하려할때 사용해주세요.

**// !** 주의해주세요
 신경쓸 부분이나 중요한 이야기가 있을  사용해주세요.

**// TODO** A부분 로직 완성하기. 여기까지 진행
 개인적으로 북마크처럼 이용하시면 용이해서 추가해봤습니다. push때에는 지워주세요.

주석을 최대한 안쓰게끔 코드를 작성해주세요!

ETC

  • console.log 지우고 PR 올립니다.
  • 삼항 연산자 사용 지양합니다.
  • 반복되는 코드를 줄입니다.
  • 함수가 하나의 일을 하도록 합니다.