자바 코딩 컨벤션 (Code Style) 적용

코딩 컨벤션은 왜 적용할까?

코딩 컨벤션은 어느 누구나 코드를 읽기 쉽고 관리하기 쉬운 규약을 따르는 것입니다. 여러 사람이 작업할 경우 일관성 있는 코드 작성을 유지할 수 있어 가독성을 높이는 데 필수적입니다. 또한, 신규 인력이 들어올 경우에도 더 빠르게 적응할 수 있습니다.

코딩 컨벤션은 서로 간의 약속입니다. 다양한 방식으로 적용할 수 있지만, 구두나 문서로만 정의하면 잊혀지거나 잘못 적용될 수 있습니다. 따라서, 네이버나 구글과 같은 대기업에서 사용하는 개발 도구에 적용 가능한 가이드를 사용하는 것이 좋습니다. 저는 네이버에서 사용하는 캠퍼스 핵데이 적용 방법을 써 볼 예정입니다.

코딩 컨벤션은 코드 작성 시 일관성을 유지하고, 가독성을 높이며, 버그를 예방하고, 코드의 효율성을 개선하는 데 도움을 줍니다. 대부분의 프로그래밍 언어에는 커뮤니티에서 추천하는 코딩 컨벤션이 있으므로, 가능하다면 이를 따르는 것이 좋습니다. 이를 통해 팀 내에서 일관성 있는 코딩 스타일을 유지하고, 유지보수성을 높일 수 있습니다.

네이버 코딩컨벤션 가이드 (캠퍼스 핵데이)

Java 코딩 컨벤션: https://naver.github.io/hackday-conventions-java/

Intellij용 가이드문서: https://naver.github.io/hackday-conventions-java/#_intellij

Eclipse용 가이드문서: https://naver.github.io/hackday-conventions-java/#_eclipse

 

위 사이트에서 보면 한글로 코딩컨벤션에 대한 정의를 잘 볼수 있습니다.
Intellij에 해당 가이드를 설치 하는 방법을 진행합니다.

Intellij 코딩컨벤션 적용 방법

1. IDE TOOLS에 맞는 Formatter.xml 다운로드.(Intellij용)
2. Preferences => Editor => Code Style => Java 선택

3. Import Schema 선택

4. 다운로드 받은 XML 파일 경로 선택

5. 선택 완료 후 OK 클릭을 하면 네이버 코딩컨벤션이 프로젝트에 적용됩니다.

수동 설정

오래전에 만들어진 코딩 컨벤션으로 기본 한줄 길이가 120으로 되어 있습니다.
넓은 모니터를 쓰면서 개발하기에는 너무 적으니 저희는 200으로 변경 할께여

Import시 와일드카드(*) 처리 없이 풀경로 노출로 하겠습니다.

저장시 코딩 컨벤션 자동 저장

Reformat code: 저장시 Code Style 적용
Optimize Import: 저장시 미사용 Import 구문 제거

 

기본적인 코딩 컨벤션 설정을 모두 끝냈습니다.
이제 코딩 컨벤션에 맞게 설정이 되어 있는지 검사 할 수 있는 Code Style 적용방법을 다음시간에 작성할께여