david's daily developer note

[BE] Naver IntelliJ formatter Setting (Code Style) 본문

[Develop] Web/Back-end

[BE] Naver IntelliJ formatter Setting (Code Style)

mouse-david 2022. 6. 30. 00:50
728x90

코드 가독성, 유지 보수성을 위하여 일관된 코드 스타일을 만드는 것은 매우 중요하다.
(우리 조상님들은 코드를 A4 용지로 출력해서 검사 맞고 그랬다고...한다.)

여러 사람이 함께 개발할때는 너무 당연하게 중요한데, 요즘은 가끔 혼자 공부하다보면,
자동으로 만들어지는 import문이,, 코드올릴때마다 바뀌고 Change가 생겨서 Commit이 지저분해진다.
그래서 자주 쓰는 스타일을 프로젝트 단위로 등록하거나, IDE자체에 디폴트로 등록하면 좋다..

이 글에서는 Intellij에 캠퍼스 핵데이 (네이버 해커톤) Java 코딩컨벤션을 적용해본다.

1. 포멧터 다운로드 위치로 이동
https://github.com/naver/hackday-conventions-java/blob/master/rule-config/naver-intellij-formatter.xml 

 

GitHub - naver/hackday-conventions-java: 캠퍼스 핵데이 Java 코딩 컨벤션

캠퍼스 핵데이 Java 코딩 컨벤션. Contribute to naver/hackday-conventions-java development by creating an account on GitHub.

github.com

2. Raw버튼 위에서 마우스 우클릭하고 다른 이름으로 저장

3. IntelliJ ▶ File ▶ Settings 메뉴로 이동한다. (단축키 Alt + Shift + S )

4. Editor ▶ Code Style ▶ Java ▶Scheme 항목의 오른쪽에 있는 톱니바퀴 아이콘을 클릭

5. Import Scheme > IntelliJ IDEA Code Style XML 을 선택한다.

6. 다운로드한 naver-intellij-formatter.xml을 선택한다. To 항목은 스타일의 식별자로, 여러 프로젝트에서 참조되는 이름이다. OK버튼을 누르면 설정이 완료된다.

7. 이후부터 자동 생성되는 코드 혹은 코드 자동 정렬 (Ctrl+Alt+L) 기능을 사용하면, 적용한 코딩 컨벤션 포맷에 맞게 수정된다.

출처 : https://naver.github.io/hackday-conventions-java/#_intellij

728x90