네이밍 규칙

• lowerCamelCase 사용
  • 클래스, 인터페이스, db스키마의 경우 UpperCamelCase
• dto : 도메인 + 자유롭게 작성 + request or response
• 함수명 : 동사+명사
  • API와 직결되는 함수는 CRUD 명칭을 앞에 달기
    • ex. Create → create000 Read → get000 (getUserById, getUsers) Update → update000 Delete → delete000
• 변수명 : 명사+명사 or 형용사+명사
• 명사는 단수로 쓰지 않되 개수를 나타내는 단어 꼭 적어주기
  • 리스트 형식을 제외한 모든 명사는 단수형 사용
  • ex. 복수 : getUsers() / 단수 : getUser()

그 외 코드 작성 시 유의 사항

• Exception

  • 서비스 로직에 관련된 예외는 서비스 단에서 던지기
  • validation 관련 예외는 컨트롤러 단에서 던지기

• Type Assertion

  • type 지정 필수
    • 변수, 함수 모두
  • 서비스 단에서 스키마와 관련된 변수 및 함수 타입 단언은 경우의 따라 단언을 하지 않을 수 있다.

• 주석 작성 시 띄어쓰기 넣기

  // 이렇게
  
  /**
   * 여기에 이렇게 합시다
   */
  

들여쓰기 및 띄어쓰기

• 들여쓰기에는 탭(tab) 대신 4개의 space를 사용합니다.
• 클래스 내 변수는 한 줄 공백을 두고 작성합니다.