Skip to content

Code Convention

minjgziii edited this page Jan 6, 2025 · 1 revision

Code Convention

Naming Rules

  • package : 소문자

    • 예시 : controller
  • 변수 : camelCase

    • 예시 : goodPerson
  • 클래스 : PascalCase, 명사

    • 예시 : CafeController
  • 함수 : PascalCase, 동사

    • 예시 : getUserName
  • 상수 : snake_case

    • 예시 : getUserName
  • Controller 내 함수명

    • 예시 : List() - 목록 조회 유형의 서비스
    • 예시 : Details() - 자세한 상세 조회 유형의 서비스
    • 예시 : Save() - 등록/수정/삭제가 동시에 일어나는 유형의 서비스
    • 예시 : Add() - 등록만 하는 유형의 서비스
    • 예시 : Modify() - 수정만 하는 유형의 서비스
    • 예시 : Remove() - 삭제만 하는 유형의 서비스
  • Service 내 함수명

    • 예시 : find...() - 조회 유형의 서비스
    • 예시 : add...() - 등록 유형의 서비스
    • 예시 : modify...() - 변경 유형의 서비스
    • 예시 : remove...() - 삭제 유형의 서비스
    • 예시 : save...() 등록/수정/삭제가 동시에 일어나는 유형의 서비스

Clone this wiki locally