Code Convention

[jaryapp]

Comment(주석)

• TODO 주석

  • 나중에 해야할일을 설명합니다.
  • 다음과 같은 형태로 작성 // TODO: {comment} ex) // TODO: 백엔드 API개발 이후 연동 작업 필요

• FIXME 주석

  • 나중에 개선이 필요한곳에 작성합니다.
  • 다음과 같은 형태로 작성 // FIXME: {comment} ex) // FIXME: ~에 대한 위험이 있어서 개선 필요

• TODO 및 FIXME외에 코드 설명에 대한 주석은 가급적 달지 않습니다.

  • 함수명과 변수명에 의미를 잘 부여합니다.
  • 코드만으로도 프로세스를 파악하기 쉽도록 작성합니다.

ref.
vscode extenstion - TODO Hightlight

Javascript

• 예외사항을 제외하고 카멜표기법(camelCase)을 기본 변수명, 함수명 표기법으로 사용합니다.
• 자바 스크립트 코딩 컨벤션 모음

React

• 컴포넌트명은 파스칼 표기법(PascalCase)을 사용합니다.
• 함수형 컴포넌트를 사용합니다.
• React Anti Pattern를 사용하지 않도록 노력합니다.