Coding Convention - dnd-side-project/dnd-11th-5-backend GitHub Wiki

기본

Java 코딩 컨벤션의 경우, 기본적으로 캠퍼스 핵데이 Java 코딩 컨벤션 를 따르되 일부 수정해서 사용한다.

네이밍

• 클래스 : UpperCamelCase, and·or와 같은 접속사를 사용하지 않고 25자 내외로 작성
• 함수 : lowerCamelCase
• 변수, 상수 : lowerCamelCase
• DB 테이블: lower_snake_case
• 패키지: kebab-case
• ENUM, 상수: Upper_snake_case
• 컬렉션(Collection): 복수형을 사용하거나 컬렉션을 명시한다. (Ex. UserList, ChallengeMap)
• LocalDateTime: 접미사에 Time을 붙인다.
• LocalDateTime: 접미사에 Date를 붙인다.

URL

URL은 RESTful API 설계 가이드에 따라 작성한다.

• HTTP Method로 구분할 수 있는 get, put 등의 행위는 url에 표현하지 않는다.
• 마지막에 / 를 포함하지 않는다.
• _(underbar) 대신 -(dash)를 사용한다.
• 소문자를 사용한다.
• 확장자는 포함하지 않는다.

IDE 에 적용하기

• 참고 자료 : https://naver.github.io/hackday-conventions-java/#_intellij

Static Code Analysis

• code smell 을 최소화 하기 위해 ci/cd 에 static code analysis인 sonarqube 를 이용하여, 규칙을 지키지 않은 경우 merge 가 불가능하게 한다.
• 편의를 위해 intellJ 플러그인을 설치한다.
  • 참고 자료 : https://adjh54.tistory.com/340