코틀린 독학 8 comments

여기 혜성이 옵니다… 아, 죄송합니다. 간략하지만 깨달음을 주는 코멘트입니다. 그렇다면 그 의견은 정확히 무엇이며 우리에게 필요한 것은 무엇입니까? 본질적으로 이것이 바로 컴파일러가 무시하는 특수 텍스트라고 부르는 것입니다. 주석을 사용하면 코드 부분을 명확하게 하거나 컴파일 프로세스에서 제외(즉, 비활성화)할 수 있습니다. 이 과정 전체에서 주석을 사용하여 코드가 작동하는 방식과 이유를 설명합니다.

Kotlin에는 세 가지 종류의 주석이 있습니다. 그것들을 살펴보자.

줄 끝 주석

“//” 뒤에 컴파일러는 해당 줄의 나머지 텍스트를 무시합니다.

fun main() {
    // The line below will be ignored
    // println("Hello, World")

    // This prints the string "Hello, Kotlin"
    println("Hello, Kotlin")  // Here can be any comment
    /// Valid single-line comment
}

알고 계셨나요? 대부분의 코드 편집기에서는 줄에 캐럿을 배치하고 Ctrl /또는 키를 눌러 줄에 주석을 달 수 있습니다 cmd /.

여러 줄 주석

컴파일러는 /*및 */기호 사이의 모든 텍스트를 무시합니다. 한 줄 주석과 여러 줄 주석을 모두 작성하는 데 사용할 수 있습니다.

fun main() {
    /* This is a single-line comment */
    /*  This is an example of
        a multi-line comment */

    /*** Valid multiline comment
        println("Hello")
        println("World")
    **/
}

다른 댓글 안에 댓글을 넣을 수도 있습니다. 중첩된 여러 줄 주석을 작성할 때 시작 기호 /*와 닫는 */기호가 쌍을 이루는지 확인하세요.

fun main() {
    /*
    System.out.println("Hello")  // print "Hello"
    System.out.println("Kotlin") /* print "Kotlin" */
    */
}

문서 주석(문서 주석)

컴파일러는 여러 줄 주석의 모든 텍스트를 무시하는 것처럼 /**와 기호 사이의 모든 텍스트를 무시합니다. 이러한 종류의 주석을 문서 주석 ( 문서 주석*/ ) 이라고 합니다 . 문서는 다른 사람이 코드의 기능을 이해하는 데 도움이 되는 텍스트입니다. 이러한 종류의 주석을 사용하면 특수 도구를 사용하여 소스 코드에 대한 문서를 자동으로 생성할 수 있습니다.

일반적으로 이러한 주석은 해당 프로그램 요소의 선언 위에 배치됩니다. 또한 이 경우 , 등의 일부 특수 라벨이 @param도구 @return제어에 사용됩니다.

아래 예를 살펴보겠습니다.

/**
 * The `main` function accepts string arguments from outside.
 *
 * @param args arguments from the command line.
 */
fun main(args: Array<String>) {
    // do something
}

아직 문서 주석을 완전히 이해하지 못했다고 해서 두려워하지 마세요 . 나중에 우리는 그것들을 자세히 살펴볼 것입니다.

결론

코드에 삽입할 수 있는 여러 종류의 주석에 대해 간략하게 논의했습니다. 그것들을 현명하게 사용하고 수많은 주석이 항상 프로그램을 완전히 명확하게 만드는 것은 아니라는 점을 기억하십시오. 코드는 변경될 수 있으며 주석은 오래된 것이 됩니다. 주석 수를 줄이려면 자체 문서화 코드를 작성해야 하는데, 이는 초보자에게는 그리 간단하지 않을 수 있습니다. 강좌를 진행하는 동안 어떻게 하는지 배우겠습니다.