Skip to content

BE 컨벤션

Yong edited this page Nov 7, 2023 · 4 revisions

네이밍 컨벤션

  • 변수, 함수 이름: camelCase

    • 변수 명의 결과 값이 boolean 일 경우 is를 붙여서 사용하기
  • 클래스 이름: PascalCase

  • 파일 이름: kebab-case

    예시: user-table.dto.ts

규칙

  1. 약어 금지
    • num, idx 등등
  2. 들여쓰기
    • depth는 3번까지만 허용
    • eslint 적용
  3. Magic Number 사용 X
    • -1, 0, 1 은 예외
    • eslint 적용
  4. if ~ else if 지양
    • if, else 만 적용
  5. if 문 규칙
    • if 문 등의 내부가 한 줄일 경우 중괄호 사용 X
    • But, if ~ else if 문 등에서 여러 줄이 사용된 경우, 해당 if ~ else if 문에서 중괄호 사용
  6. promise 금지
    • 대신 async/await 사용
  7. 파라미터 갯수 제한
    • 최대 3개까지
    • eslint 적용
  8. 데이터베이스
    • 데이터베이스 이름: 영어 대문자, 길이는 8자 이내
    • 테이블 이름: 최대 3 단어 각 단어는 _ 구분 테이블 명 뒤에는 _TB로 테이블 구분
    • 컬럼 이름: snake 표기법
Clone this wiki locally