[kotlin] 코드 가독성 개선을 위한 주석 작성 방법 구조화하기

08 Dec 2023

코드의 가독성은 유지보수 및 협업에 있어 매우 중요합니다. 주석을 추가하여 코드를 더욱 명확하게 설명하고, 이해하기 쉽게 만들 수 있습니다. Kotlin에서는 주석을 작성하는 방법을 효율적으로 구조화하여 가독성을 높일 수 있습니다.

주석의 필요성

코드는 초기 작성자 또는 다른 개발자가 작성한 것을 이해해야 합니다. 하지만 코드만으로는 모든 정보를 전달할 수 없기 때문에 주석이 필요합니다. 주석을 통해 코드의 의도나 중요한 내용을 설명함으로써 이를 보완할 수 있습니다.

Kotlin 코드에서 주석은 아래와 같은 방법으로 구조화하여 작성할 수 있습니다.

클래스나 함수의 역할, 파라미터, 반환 값 등을 명확하게 설명합니다.

/**
* 두 수를 더하는 함수
* @param a 첫 번째 숫자
* @param b 두 번째 숫자
* @return 두 숫자의 합
*/
fun add(a: Int, b: Int): Int {
    return a + b
}

코드의 특정 부분이나 결정이 필요한 이유나 처리 과정을 설명합니다.

// 사용자의 권한에 따라 접근을 허용하는지 결정
if (user.role == "admin") {
    // 어드민 권한으로 접근
    ...
} else {
    // 일반 사용자
    ...
}

상수나 리소스의 의미를 설명하여 코드에서 사용된 의미를 명확히 합니다.

// 한 주의 일수
const val DAYS_IN_WEEK = 7

로직이 복잡한 경우, 해당 로직에 대한 설명을 추가하여 이를 이해하기 쉽게 돕습니다.

// 특정 연산을 위한 재귀 함수
fun calculate(n: Int): Int {
    if (n == 0 || n == 1) {
        return 1
    }
    return n * calculate(n - 1)
}

Kotlin에서는 주석을 구조화하여 작성함으로써 코드의 가독성을 개선할 수 있습니다. 클래스, 함수, 중요한 결정, 상수, 로직 등 각각의 주석 유형에 대해 명확하게 작성함으로써 코드를 더욱 이해하기 쉽게 만들 수 있습니다.