Coding Convention

Kotlin 코드

• 변수 (var)

  • camelCase로 작성
  • 명사 or 명사구 작성

• 상수 (val or const val)

  • UPPER_SNAKE_CASE로 작성
  • 클래스의 멤버상수에서 보통 작성(지역변수에서 작성하는 val은 적용 x - Java에서 public static final로 사용되는)

• 함수

  • camelCase로 작성
  • 동사 or 동사구 작성

• 클래스

  • PascalCase로 작성
  • .kt 파일 이름과 동일(파일 이름 == 클래스 이름)

• 주석

  1. functional comment

     /**
     function description
     @param - parameter description
     @return - return description
     @author - writer name
     @since - initial write date | modify date
     **/

  2. inline comment

     • 변수: 뭐하는 변수인지 inline으로 간략하게 설명
     • function call: 왜 호출하고, 어떤 인자가 들어가는지, 리턴 값이 뭔지

  3. block comment

     • 블럭 단위 로직(for, while, if, etc.)의 경우 블럭 상단에

     /*
     로직 설명 등등 어떻게 돌아가는지
     */
     
     // example
     
     /*
     1부터 15까지 숫자를 덧셈하는 작업
     */
     for(number in 1..15){
         sum += number
     }

• 코드 정리 - 공백

  • ctrl + alt + l 로 공백 정리

    // before
    if(a==b){}
    
    // after
    if (a == b) {
    }

XML 코드

• 모든 xml 파일 이름

  • snake_case로 작성

• 주석

  • 핵심적이고, 중요해보이는 부분에만 주석달기(라이브러리 View와 같은)

  <!-- -->

View id 이름

• View Binding 사용
  • snake_case로 작성된 id가 kotlin에서는 camelCase로 사용
• ID의 첫 단어는 View 이름으로(축약해서)
  • 레이아웃의 경우에는 layout
  • Button: btn
  • TextView: tv
  • EditText: et
  • 등등
• 그 다음 단어는 기능 명시하는 명사 or 명사구(어떻게 쓰이는지, 어디에 쓰이는지)
  • btn_login