[공통개발] Java 자바 Naming Convention (네이밍 컨벤션), JavaDoc (함수 및 클래스 문서), Swagger (API 문서)

📝──── Java Naming ────

• 프로젝트명
  • snake_case
  • 예) shinhan_delivery

• 패키지명
  • com.회사명.프로젝트명 (snake_case)
  • 예) com.naver.advertise_admin

• 클래스명
  • 첫글자 대문자 + camelCase
  • 예) WeaponFactory

• Enum
  • PascalCase
  • 예) Fruit
  • 예) enum Fruit {APPLE, ORANGE, BANANA, PEAR};

• 메소드명
  • (동사 or 전치사) + camelCase  → 한 가지의 역할을 해야 한다
  • 예) getParts, toString
  • 자주쓰이는 동사 → get (가져오다) set (설정하다) find (찾다) init (데이터 초기화) create (생성하다) delete (삭제하다) update (갱신하다)

• Boolean
  • (is, has, can) + (형용사 or 명사) + camelCase
  • 예) boolean isBroken, boolean hasBanana, boolean canFix

• 변수명
  • 명사 + camelCase
  • 예) smartPhone
  • 자주 쓰이는 명사 → total (전체) count (개수)

• 상수
  • screaming_snake_case
  • 예) SHOP_NAME

• 배열
  • camelCase + 복수형
  • 예) fruits → fruits[0] = banana , fruits[1] = apple
• JSONObject
  • camelCase
  • 예) student
  •  
• JSONArray
  • camelCase + 복수형
  • 예) students
•  
• JSON 키
  • calmelCase
  • 예) “shopNm” : “맛있는 짜장면집”
  • 만약 DB에서 조회한 값 그대로 Return해 DB field 네이밍인 snake_case로 내려오는 경우는 그냥 사용
    • 예) “shop_nm” : “맛있는 짜장면집”
• 약어
  • number = num
  • address = addr
  • name = nm
  • temp = tmp
  • 약어를 사용할 경우 널리 사용하는 것이 아니면 약어리스트에 추가하고 공통적으로 관리하는게 좋다

 

솔직히 모든 Naming Convention을 세세한 것까지 지키면서 한 사람이 작성한 것처럼 보이기는 쉽지 않다 하지만 아무리 그래도 위에 정한 큰 틀은 지키는게 좋다

 

📝JavaDoc (자바 클래스 및 메소드 주석)

JavaDoc은 JDK와 함께 패키지로 제공되는 도구로 Java소스 코드의 코드 문서를 생성하는데 도움을 주는 도구로 JDK기본적 + 공식적으로 지원하기 때문에 이용하는게 좋다 → 일단 사용해봐야 알 거 같음

 

📝Swagger (API 문서)

백엔드에서 쓰이는 경우 API문서의 경우 Swagger로 작성하고 공통 메소드나 그 외의 클래스의 경우는 JavaDoc으로 작성하는게 좋아보인다 → 일단 사용해봐야 알 거 같음