Andromeaning Coding Style

Android Coding Style

0. 파일 제작자 표시

해당 파일 작성자를 파일 최상단에 표기합니다.

/*
 * Created by <github id>
 * DESC: <설명>
 */

1. Kotlin Language Rules

Kotlin 코드 스타일의 규칙을 따른다.

2. Import의 경우 전체를 다 표시할 것

Import 문에서 와일드카드 사용을 금합니다.

3. 클래스와 함수명은 반드시 그 의도를 명확하게 구분할 수 있는 이름으로 만든다.

권장사항) 최대 3~4단어로 명명

권장사항을 지키기 힘든경우 길어도 상관없으니 의도를 최대한 명확하게 구분 가능하도록 명명한다.

3-1. 축약어를 사용하지 않습니다.

축약어 사용을 금합니다.

4. 함수

#### 4-1. 함수 서명 규칙

함수 서명이 한 줄에 들어가지 않으면 각 매개변수 선언을 한 줄에 하나씩 표시합니다. 이 형식으로 정의된 매개변수에서는 단일 들여쓰기를 사용해야 합니다. 닫는 괄호()) 및 반환 유형은 추가 들여쓰 기 없이 한 줄에 하나씩 입력됩니다.

fun <T> Iterable<T>.joinToString(
    separator: CharSequence = ", ",
    prefix: CharSequence = "",
    postfix: CharSequence = ""
): String {
    // …
}

4-2. 함수 최대 작성 허용 line

특별한 경우가 아닌이상 각 함수는 40줄 이상 작성하지 않는다.

함수가 40줄이 넘지 않도록 작성하며, 40줄을 넘긴경우 설계가 잘못된 것일 수 있음을 검토 해야 합니다.

4-3. 함수 최대 인자수 제한

메소드 인자수는 최대 3개로 제한합니다.

그럼에도 3개 이상 전달 해야하는 경우 dataClass 혹은 배열, Map, Pair 등을 고려합니다.

5. 한줄에는 하나의 .만을 허용합니다.

디미터의 법칙을 지키기.

한줄에는 하나의 .만을 사용할 것.

6. Define Fields in Standard Place

Fields 선언은 표준위치를 지킨다.

권장 사항 1) else 키워드를 사용하지 않는다.

if(num < 0){
    println("negative number")
    return
}
println("positive number")

권장사항 2) TODO, FIXME 주석 사용

단기 처방 및 완벽하지 않은 해결 책일 경우 해당 주석문을 사용합니다.

권장사항 3) 주석의 사용

주석 사용을 최대한 지양합니다.

정말 설명이 필요한 경우는 사용이 가능하나, 주석 또한 유지보수 해야함을 잊지 않습니다.

그 이외 굳이 필요하지 않은 주석은 작성하지 않습니다.