코딩 컨벤션을 맞춰보자~

https://developer.android.com/kotlin/style-guide

Kotlin 스타일 가이드  |  Android 개발자  |  Android Developers

저자는 위의 스타일 가이드를 따른다.

코틀린 컨벤션이란 어떤 프로젝트를 접해도 쉽게 이해할 수 있고 다른 외부 개발자도 프로젝트의 코드를 쉽게 이해할 수 있다.

그래서 지키는것이 좋은데 이걸 하나하나 외우는건 너무 힘들다;;(코틀린 컨벤션이라 구글링하면 더 자세하게 볼 수 있다.!)

내가 실수해도 알아서 IDE가 잡아주면 얼마나 좋을까..??

생각만 해도 흐믓...ㅎ

그래서 이번 포스팅은 세가지의 설정으로 자신의 코드를 깔끔하게 해주는 설정들을 해보자

 

1. File -> Setting -> Editor -> Code Style -> Kotlin -> set from -> Kolin style guide 설정!!

(맥 : Preference(Cmd + ,))

2. File -> Setting -> Editor -> Inspections -> File is not formatted according...... 체크하기

그 후 경고 단계를 Error로 맞춰주자!

나는 나만의 커스텀으로 "codeconvention" 이란 경고문을 만들고 색은 초록색으로 변경했다.

이렇게 하면 아래와 같이 띄어쓰기 같은 컨벤션을 잡을 수 있다.

3. File -> Setting -> Plugins -> Marketplace -> Ktlint 설치!!

 

위와 같이 하면 아래와 같이 표시 및 정리를 해준다!!

추가로 xml 을 개발할때 View의 마지막을 한줄 띄워서 닫아주는 것도 기억하자!!

이유는 한칸 띄지 않다면 코드를 추가할때 끝부분이 commit 할때 상대방이 pull/request할때 바뀐부분이 표시되기 때문이다.

 

참고로 아래에는 우리팀의 코드 작성시 규약을 해놓았다.

아래있는것은 외우고 나중에 Ktlint에 추가해보도록 하자

 

1) 코틀린 & 자바

- 파일명: 파스칼 표기법 (ex> int TotalNumber)

- 그외(변수, 함수): 카멜 표기법 (ex> int totalNumber)

2) xml

- 뷰 ID: 스네이크 표기법 (ex> int total_number;)

3) xml 에서 id 사용법

- 뷰의 id 선언: @+id/name

- 선언된 뷰의 id를 참조: @id/name

ex>

<Button 

   android:id="@+id/start"

   android:layout_width="wrap_content"

   android:layout_height="wrap_content"

/>

 

<Button 

   android:id="@+id/check"

   android:layout_width="wrap_content"

   android:layout_height="wrap_content"

   android:layout_below="@id/start"

/>

4) ConstraintLayout 

- layout_constraintLeft_toLeftOf -> layout_constraintStart_toStartOf

- layout_constraintRight_toRightOf -> layout_constraintEnd_toEndOf