주석 처리 방법 - swkim0128/PARA GitHub Wiki

코틀린에서 주석은 코드를 설명하거나 일시적으로 실행되지 않도록 막기 위해 사용됩니다. 코틀린은 자바와 동일한 주석 문법을 사용합니다.

• //로 시작하며, 해당 줄의 끝까지 주석으로 처리됩니다.
• 주로 간단한 설명이나 특정 코드 라인의 용도를 표시할 때 사용됩니다.

예제

fun main() {
    _// 이 함수는 프로그램의 진입점입니다._
    println("Hello, Kotlin!") _// 콘솔에 출력_
}

• /*로 시작하고 */로 끝납니다.
• 여러 줄에 걸쳐 주석을 작성할 때 사용됩니다.

예제

/*
이 함수는 "Hello, Kotlin!"을 출력합니다.
프로그램 실행 시 이 메시지가 표시됩니다.
*/

fun main() {
    println("Hello, Kotlin!")
}

• 코틀린에서는 여러 행 주석을 중첩해서 사용할 수 있습니다.
• 주석 내부에 또 다른 여러 행 주석을 작성할 수 있습니다.

예제

/*
    주석 예제:
    /* 중첩된 주석입니다. */
    여러 줄 주석입니다.
*/

fun main() {
    println("Nested comments are allowed in Kotlin!")
}

• 주석은 코드의 가독성을 높이기 위해 사용되어야 합니다. 지나치게 남용하면 오히려 코드를 읽기 어렵게 만들 수 있습니다.
• 코드가 자주 변경된다면, 주석도 업데이트해야 하므로 코드 자체를 명확하게 작성하는 것이 중요합니다.

1. 코드 비활성화

• 실행하고 싶지 않은 코드를 주석 처리하여 비활성화할 수 있습니다.

fun main() {
    // println("이 코드는 실행되지 않습니다.")
    println("이 코드는 실행됩니다.")
}

2. TODO 주석

• TODO 키워드를 사용하면 IDE에서 해당 작업을 추적할 수 있습니다.

fun main() {
    // TODO: 사용자 입력 기능 추가
    println("Hello, Kotlin!")
}

코틀린의 주석을 적절히 사용하면 코드의 가독성을 높이고 유지보수를 용이하게 만들 수 있습니다.