코드 컨벤션을 본인 혹은 조직에서 적용해보자.
등의 권위있는 서비스들의 컨벤션을 권장한다.
적용 가능한 설정 방법들에 대해 알아보자.
IntelliJ Formatter(code styles)
인텔리제이에서 코드를 작성할 때, 적용되는 코드 스타일 설정이다. 인텔리제이의 Setting
-> Editor
-> Code style
에서 설정할 수 있다. .editorconfig
파일로 내보낼 수도 있다.
참고: Code style and formatting | IntelliJ IDEA
.editorconfig
인텔리제이를 떠나 여러 IDE에서 활용가능한 컨벤션 파일이다.
루트 경로에 해당 파일을 넣으면 (코드 작성시) 적용이 되기에 깃을 이용하여 공유하면 유용하다. 인텔리제이 코드 스타일과 비교하였을 때, 세부적인 설정(src, test에 따른 구분) 등에 사용할 수 있다고 한다.
참고
Check-style
정적 코드 분석 도구(플러그인)이다. 실행시키면 해당 컨벤션이 맞게 적용이 됐는지 아닌지를 알려준다.
참고
캠퍼스 핵데이 Java 코딩 컨벤션 - 부록
부터 참고하자. IntelliJ Foramtter, .editorconfig
, Check-Style은 물론 maven, gradle의 빌드도구에 적용하는 방법까지 나와있다.