[Android] 네이밍/변수 규칙 (feat. Kotlin 코딩 컨벤션)

안드로이드 개발을 하는데에 있어서 변수나 메소드의 네이밍 규칙에 대해서 알아보고자 한다.

1) 네이밍 규칙/방식 종류

네이밍 규칙/방식 종류에 대해서 5가지의 네이밍 방법을 알아보자.

각 네이밍 방법은 사실 상황에 따라 달리 쓰인다.

1. lowerCamelCase

• 각 단어의 첫 문자를 대문자로 표시하되, 해당 메소드명이나 변수명은 소문자로 적는 방법이다.
• 예시) lowerCamelCase() , upperCamelCase()

2. UpperCamelCase

• 전체 이름의 첫 문자를 모두 대문자로 표시하는 방법입니다.
• 예시) LowerCamelCase() , UpperCamelCase()

3. snake case

• 각 단어 사이를 언더바로 구분해주는 방법입니다
• 예시) max_count , USER_NAME_FIELD

4. all lowercase

• 모든 문자를 소문자로 적어주는 방법 입니다.
• 예시) com.sun.eng , com.apple.quicktime.v2

5. all uppercase

• 모든 문자를 대문자로 적어주는 방법입니다.
• 예시) TYPE_PETTERN , GET_THE_CPU

2) 상황별 네이밍 규칙/방식 적용

1. 패키지 명 (Package Name)

• 패키지의 모든 문자는 all lowercase 방식을 사용해야 합니다.
• 단어가 2개 이상인 경우 해당 단어는 하위 모듈로 사용되거나 snake_case로 작성해야 한다.
• 공백은 허용되지 않는다.

  ex) <com/org>.<회사명>.<제품명/프로젝트명>.<최상위모듈>.<하위모듈>

    org.apache.common.lang.StringUtils;

2. 클래스 명 (Class Name)

• 모든 클레스 이름은 UpperCamelCase 방식을 사용해야 합니다.

  public class HelloWorld{            // 클래스명
  
  }

3. 메소드 명 (Method Name)

• 메소드 이름, 인수 및 반환 변수 이름의 경우 lowerCamelCase를 사용한다.

  public class HelloWorld{   // 클래스명
  	 public void runFast(String familyName){   // 메소드명
    }
  }

4. 파라미터 명 & 로컬 변수 명 (Parameter names & Local variable names)

• 최초에 사용된 단어를 제외한 모든 단어의 첫 문자가 대문자이며, 나머지는 소문자로 표기한다.
• lowerCamelCase 방식을 사용해야 합니다.

  int totalCost = 0;               // 변수명

  String fullName = "";                  // 변수명

  public void HelloCity(String familyName){};          // 파라미터명

5. 상수 명 (Constants names)

• 상수 이름은 모두 대문자를 사용하고 각 단어 사이를 언더바로 표기한다.
• all uppercase & snake case 방식을 사용한다.

static final int MAX_WIDTH = 999;

static final int GET_THE_CPU = 1;

static final String USER_NAME_FIELD = "UserName";

3) 안드로이드 공식 홈페이지 지정 규칙

안드로이드 공식 홈페이지 이름 지정 규칙

Kotlin의 공식사이트의 명명 규칙

4) 코딩 컨벤션 - Kotlin

코틀린 스타일 가이드

코틀린 코딩 컨벤션