[이펙티브 코틀린] Item18. 코딩 컨벤션을 지켜라

코딩 컨벤션이란  읽고 관리하기 쉬운 코드를 작성하기 위한 일종의 코딩 스타일 규약입니다.

코틀린은 굉장히 잘 정리된 코딩 컨벤션을 갖고 있습니다.

코틀린뿐만 아니라, 어떤 개발 언어든 공식적인 컨벤션을 따르는게 좋습니다.

 

• 어떤 프로젝트를 접해도 쉽게 이해할 수 있다.
• 다른 외부 개발자도 프로젝트의 코드를 쉽게 이해할 수 있다.
• 다른 개발자도 코드의 작동 방식을 쉽게 추측할 수 있다.
• 코드를 병합하고, 한 프로젝트의 코드 일부를 다른 코드로 이동하는 것이 쉽다.

 

IntelliJ 에서 설정이나 도구, 플러그인을 활용해 코틀린 컨벤션 검사를 할 수 있습니다.

 

1. Setting ➡ Editor ➡ Code Style ➡ Kotlin 클릭
2. 우측 상단 Set from... ➡ 원하는 스타일 가이드를 지정
3. Style issues File ➡ [File is not formatted according to project settings] 체크

 

또는 아래와 같은 정적 분석 툴이나 Intellij 플러그인을 활용하는 것도 좋습니다.

 

• ktlint - 공식 가이드에 기반한 코드 스타일과 컨벤션을 검사한다.
• detekt - 다양한 옵션을 제공하며 컨벤션과 함께 코드 품질을 검사한다.

 

 

 

---

정리

 

• 코딩 컨벤션은 가독성의 끝판왕이다.
• 코딩 컨벤션을 확실하게 읽고, 정적 검사기를 활용해서 프로젝트의 코딩 컨벤션 일관성을 유지하라.