코딩 컨벤션

코딩 컨벤션

Test

• __tests__ 파일에 테스트 코드를 정리한다.
• __mocks__ 파일에 모킹 코드를 정리한다.
• __test-data__ 파일에 테스트용 데이터를 정리한다.

개발과정에서 Linter를 적용하여 문법적 일관성을 꾀한다.

• FE는 Airbnb React 가이드를 준수하며, BE는 eslint-config-airbnb-base를 사용한다.

부득이한 경우가 아니면 화살표 함수를 사용한다.

비동기 작업은 콜백 지옥이 만들어지지 않도록 한다.

• 콜백을 한 단계 더하기보다는 Promise를 지향한다.
• Promise를 지향하기보다는 async/await 방식을 지향한다.
  • API와의 통신 등 error-proof하지 않은 부분의 async/await를 사용하는 경우, try/catch를 사용하여 에러 처리를 한다.

반복문/조건문의 사용은 다음과 같이 한다.

• 조건문
  • 조건문은 다음과 같이 multi-line으로 구현한다.
  • one-line도 multi-line으로 구현한다.

if () {
  ...
  ...
  return;
} else if () {
    return;
} else {
    return;
}

• 반복문
  • forEach와 고차함수(map, filter, reduce)를 선호하되, 상황에 따라 다른 형식도 사용한다.

주석은 다음과 같이 타입을 명시해준다.

• 여러 줄로 이루어진 주석을 사용할 경우 첫 줄과 마지막줄은 /*, */로 한다.
• 주석은 필요에 따라 다음의 머리말 중 하나를 택일한다.
  • TODO: 추후 작업이 필요한 코드
  • HELP: 추후 코드 리뷰 등에서 팀원과 논의가 필요한 코드
  • HACK: 임시로 해결한 코드. 핵을 왜 사용했는지 정보가 있어야 하며, 더 나은 방법으로 해결할 수 있음을 뜻한다.
  • XXX: 코드에 문제가 있어 가능한 빨리 수정되어야 함을 의미한다.
  • 예시

  /* TODO
  code...
  */