[Kotlin] 주석(Comment)

숭맹이·2025년 4월 22일

kotlin

김영한님의 자바 입문 - 코드로 시작하는 자바 첫걸음 정리

주석이란 무엇인가?

주석(Comment)은 프로그램 코드에 설명을 추가하는 것으로, 컴파일러나 인터프리터가 무시하는 텍스트입니다.

"주석은 '나' 뿐만 아니라 '남'을 위해 존재한다."

코드를 처음 작성할 때는 모든 게 명확해 보이지만, 시간이 지나거나 다른 개발자가 코드를 보게 되면 의도나 맥락이 불명확할 수 있습니다.

Kotlin에서 주석 작성 방법

Kotlin에서도 Java와 동일하게 두 가지 방식으로 주석을 작성할 수 있습니다.

1. 한 줄 주석 (Single-line Comment)

문법: // 이후의 내용은 모두 주석으로 간주합니다.

// 이 코드는 사용자 정보를 출력합니다.
println(userInfo)

2. 여러 줄 주석 (Multi-line Comment)

문법: /*로 시작하고 */로 끝나는 구간을 주석으로 처리합니다.

/*
 이 코드는 사용자 정보를 출력하는 부분입니다.
 오류 발생 시 예외를 처리합니다.
*/
println(userInfo)

보통 "대규모 설명"이나 "여러 줄을 주석 처리"할 때 사용합니다.

주석의 좋은 예와 나쁜 예

좋은 주석

왜 그렇게 작성했는지를 설명한다.
비즈니스 로직이나 복잡한 알고리즘의 맥락을 제공한다.
최소한으로, 하지만 필요한 만큼 작성한다.

// 패스워드 암호화: 보안을 위해 SHA-256 해시 적용
val hashedPassword = encryptSHA256(password)

나쁜 주석

코드 자체를 그대로 설명한다.
코드 수정 시 주석을 업데이트하지 않아 오히려 혼란을 초래한다.
너무 과도하거나 불필요하게 장황하다.

// 비밀번호를 암호화한다 (코드를 보면 암호화하는 거 다 보이는데 굳이?)
val hashedPassword = encryptSHA256(password)

실제 예제: CommentKotlin 파일

fun main() {
    // 프로그램 시작점입니다.
    println("hello kotlin1") // 첫 번째 출력 메시지

    // println("hello kotlin2") // 필요 시 복구할 수 있도록 남겨둠

    /*
     여러 줄 주석 처리 예시
     이 아래 코드는 현재 사용되지 않음.
     println("hello kotlin3")
     println("hello kotlin4")
    */
}