[Effective Kotlin] 18 - 코딩 컨벤션을 지켜라

Kotlin 문서의 Coding Convention을 보면 알 수 있는 것처럼, Kotlin은 굉장히 잘 저리된 코딩 컨벤션을 가지고 있습니다. 물론 이러한 컨벤션이 모든 프로젝트에 최적인 것은 아니지만, Kotlin 커뮤니티에 속한 사람이라면 이러한 컨벤션을 최대한 지켜주는 것이 좋습니다.

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

Kotlin 개발자라면 문서에 설명되어 있는 컨벤션에 익숙해져야 합니다. 그리고 컨벤션은 시간이 지나면서 조금씩 변화할 수 있는데, 이런 변화도 받아들일 수 있어야 합니다.

컨변션을 지킬때 도움이 되는 두 가지 도구가 있습니다.

1. IntenlliJ 포매터: 공식 코딩 컨벤션 스타일에 맞춰서 코드를 변경해 줍니다.
   Settings → Editor → Code Style → Kotlin에서 오른쪽 위의 'Set From...' 링크를 누른 뒤, 메뉴에서 Predefine Style/Kotlin style guide를 선택하면 사용할 수 있습니다.
2. ktlink: 많이 사용되는 코드를 분석하고 컨벤션 위반을 알려주는 linter입니다.

자바 개발자가 여러 코틀린 프로젝트를 살펴보면, 코딩 컨벤션을 따로 보지 않아도 어느 정도 쉽게 이해라 수 있을 것입니다. 이는 Kotlin이 Java의 코딩 컨벤션을 잘 따르고 있으며, 많은 Kotlin 개발자가 이전에 Java개발자였기 때문일 수 있습니다.

 

자주 위반되는 규칙중 하나는 클래스와 함수 형식입니다.

class FullName(val name: String, val surname: String)

하지만, 많은 파라미터를 갖고 있는 클래스 및 함수는 각각의 파라미터를 한 줄씩 작성하는 방법을 사용합니다.

 

많은 개발자가 코딩 컨벤션을 지키지 않습니다. 하지만 코딩 컨벤션은 굉장히 중요합니다. 가독성과 관련된 어떤 책을 보아도, 코딩 컨벤션과 관련된 내용을 강조한다는 것을 확인할 수 있을 것입니다. 코딩 컨벤션을 확실하게 읽고, 정적 검사기를 활용해서 프로젝트의 코딩 컨벤션 일관성을 유지해야 합니다.