<aside> 📢 코딩 컨벤션: 플러그인 직접 보면서 하기!

</aside>

• 참고자료

Tool

• IntelliJ

Version

• Java 17
• Spring Boot 3.1.10
• Spring Security 6.x

기본적인 컨벤션

기본적인 사항

코드 스타일을 적용시키고 항상 코딩 작업을 마친 후에는 reformat code(단축키 : cmd + alt + L)을 통해 간격, 공백등의 코드 스타일을 적용시킨다. (코드 스타일을 IDE에 적용시켰다는 전제하에)

또한 코드에 사용되지 않은 라이브러리를 삭제해준다. (단축키 : ctrl + alt + O)

Naming

1. 기본적으로 네이밍은 누구나 알 수 있는 쉬운 단어를 선택한다.
   • 우리는 외국인이 아니다. 쓸데없이 어려운 고급 어휘를 피한다.
2. 변수는 CamelCase를 기본으로 한다.
   • userEmail, userCellPhone ...
3. URL, 파일명 등은 kebab-case를 사용한다.
   • /user-email-page ...
4. 패키지명은 단어가 달라지더라도 무조건 소문자를 사용한다.
   • frontend, useremail ...
5. ENUM이나 상수는 대문자로 네이밍한다.
   • NORMAL_STATUS ...
6. 함수명은 소문자로 시작하고 동사로 네이밍한다.
   • getUserId(), isNormal() ...