[Spring/Java] 프로젝트, 패키지, 클래스, 메서드 명명 규칙

FE.1·2023년 1월 24일
2

🚀 공통

  1. 대소문자 구분
  2. 예약어 X
  3. 숫자로 시작 X
  4. 특수문자는 _ 혹은 $ 만 허용
  5. 파스칼 표기법과 카멜 표기법을 사용
  6. 반의어는 반드시 대응하는 개념으로 사용

1️⃣ 프로젝트

  • 대소문자 구분없이 시작 가능
  • 대문자 사용을 권장

2️⃣ 패키지

  • 대소문자 모두 허용하지만, 클래스명과 쉽게 구분하기 위해 소문자로 하는 것을 원칙
  • 표준 패턴을 따른다. EX) [com].[Company].[Project].[toppackage].[lowerpackage]
  • 가급적 한 단어 사용 권장
  • 좋은 예: com.nexon.Maplstory.member.object
  • 나쁜 예: com.nexon.MaplestoryMemberObject

3️⃣ 클래스

  • 파스칼 표기법 사용
  • 명사로 시작
  • EX) HelloWorld, TestWorld

4️⃣ 인터페이스

  • 파스칼 표기법 사용
  • 형용사를 사용
  • EX) Runnable, Remote

5️⃣ 메서드

  • 카멜 표기법 사용
  • 동사로 시작

메서드명의 여러 접두사

  1. 속성에 접근: get/set
  2. 데이터 생성: create
  3. 데이터 조회: find
  4. 데이터 변경: modify
  5. 데이터 삭제: delete
  6. 데이터 입력: input
  7. 데이터 초기화: init
  8. 데이터 불러오기: load
  9. 데이터 유무 확인: has
  10. B를 기준으로 A를 하겠다: By
    EX) public void getUserByName()

6️⃣ 변수와 상수

변수

  • 카멜 표기법

상수

  • 전부 대문자로 표기
  • 스네이크 케이스 사용

[참고] https://dkswnkk.tistory.com/539

profile
공부하자!

0개의 댓글