Code Convention

📗 Code Convention

변수 표기 : 카멜 표기법

• 전역 변수 : m으로 시작하는 카멜 표기법

  • 상수 : 파스칼 표기법

Class, Object, Interface 표기 : 파스칼 표기법

• Interface : 파스칼로 표기하되 마지막에 Interface 붙여줄 것

  • Data Class : 파스칼로 표기하되 마지막에 Data 붙여줄 것

    • 이름을 딱 봐도 무슨 기능인지 알 수 있게 표시, 줄임말 최대한 자제.

함수 표기 : 카멜 표기법

• Class, Object, Interface 작성과 동일

디렉토리 표기 : 소문자 표기

• 줄임말 쓰지 않기 ( ex. 뷰홀더 디렉토리 -> vh (X) )

xml 표기 : 스네이크 표기

뷰 id 표기 : 스네이크 표기

• 위젯_프래그먼트or액티비티 이름_뷰의 역할 ( ex. btn_law_register )

위젯 표기

• Button : btn

• TextView : txt

• EditTextView : edt

• ImageView : img

• RecycelerView : rcv

• ViewPager : vp

매개변수 : 안드로이드 스튜디오 가이드라인을 넘길 시, 모든 매개 변수 엔터로 개행

• 예시

override fun getItemOffsets(
       outRect: Rect,
       view: View,
       parent: RecyclerView,
       state: RecyclerView.State) {
       with(outRect) {
           if (parent.getChildAdapterPosition(view) == 0) {
               top = spaceHeight
           }
           left =  spaceHeight
           right = spaceHeight
           bottom = spaceHeight
       }
   }