Kotlin Coding Convention은..?

Kotlin으로 Back-end를 개발함에 따른 coding convention을 설정하는 과정이다.

---

1. java coding convention

프로젝트를 진행 전, 자바로 진행 예정이라 코딩 컨벤션을 맞추기 위해서 naver coding convention을 참고하려고 했다.

formatter.xml을 통해서 설정해주고, CheckStyle을 적용함으로써 정적 분석 도구를 활용하는 방식으로 convention을 지키는 것이다.

 

 

---

2. Koltin Coding Convention

개발언어를 kotlin으로 바꾸면서 jvm을 기반으로 하는 언어이기에 convention을 그대로 적용해도 되겠지. 라는 생각을 했었다.

생각해보니 확인은 해봐야했다.

question으로 물어볼 수 있는 최고의 접근성을 가진 ChatGPT 선생께 물어보았다.

 

선생의 말을 보면 알겠지만 완전히 다르게 생각하고 있었다.

그래도 공식 사이트에서 제공하는 가이드가 있다는 건 아주 고무적인 소식이다.

고쳐야겠지?

---

3. Kotlin Coding Convention

https://kotlinlang.org/docs/coding-conventions.html#modifiers-order

Coding conventions | Kotlin

(한글 번역판)

https://velog.io/@dev-baik/Kotlin-Coding-conventions

Kotlin Coding conventions

 

공식 사이트에 자세한 컨벤션은 있다.

코딩 스타일 적용하는 법만 알아보자

 

아주 훌륭한 커뮤니티다. 요즘에도 수정하시네

 

-1 Kotlin Code Style 설정

 

-2 스타일 가이드 활성화

 

---

4. Ktlint

kotlin의 정적 코드 분석 도구인 Ktlint는 다음과 같은 기능을 제공한다.

 

Ktlint 공식

https://github.com/jlleitschuh/ktlint-gradle#intellij-idea-only-plugin

GitHub - JLLeitschuh/ktlint-gradle: A ktlint gradle plugin

 

설명(잘 돼있음)

https://studynote.oopy.io/kotlin/2#a543f3ce-a187-45c6-92d7-c9712c53f66c

Ktlint 기반 스타일 체크 환경 구축

 

 

-1 기본 사용법

 

1) 스타일 체크

./gradlew ktlintCheck

2) 스타일 명세에 따른 자동 맞춤

./gradlew ktlintFormat

 

-2 Commit 단계 자동 체크

./gradlew addKtlintCheckGitPreCommitHook

 

-3 CI 단계 스타일 강제