Comments - 주석

hyperskill - Comments 영어 원문

자바 프로그램 내부에서, 자바 컴파일러를 무시하는 특별한 텍스트를 작성 할 수 있습니다 - 주석 기능

주석은 컴파일 과정에서 코드를 제외하거나, 당신이 작성한 코드의 일부분을 다른 개발자에게 밝히게 해 줍니다.

우리 자료에서는, 이론과 연습에 있는 주석이 코드에서 어떻게 작동하는지 설명하기 위해 사용합니다.

자바 프로그래밍 언어는 세 가지 종류의 주석을 지원합니다.

End-of-line comments - 한 줄 주석

---

자바 컴파일러는 // 부터 끝 부분 까지 텍스트를 무시합니다.

class Program {
    public static void main(String[] args) {
        // The line below wiill be ignored - 밑의 코드는 컴파일러가 무시합니다.
        // System.out.println("Hello, World!"); - 코드도 무시합니다.
        // It prints the string "Hello, Java" - 밑의 코드는 "Hello, Java"를 출력합니다.
        System.out.println("Hello, Java"); // Here can be any comment - 어떤 말이던 올 수 있습니다.
    }
}

위의 예제에서 // 이후의 텍스트는 컴파일러에 의해 무시합니다.

Multi-line comments - 여러 줄 주석

---

컴파일러는 /* 부터 가장 가까운 */ 까지의 모든 텍스트를 무시합니다.

이는 여러 줄, 혹은 단일 주석에 사용 할 수 있습니다.

class Program {
    public static void main(String[] args){
        /* 단일 줄 주석 */
        /* 여러 줄의 주석 
         예제를 보여줍니다. */
    }
}

여러 줄 주석 내부에 단일 줄 주석을 중첩 할 수 있습니다 :

class Program {
    public static void main(String[] args){
        /*
         System.out.println("Hello"); // "Hello" 출력 
         System.out.println("Java"); // "Java" 출력 
         */
    }
}

위 코드의 일부분은 컴파일러에 의해 무시되는데, 이는 /* ... */ 문자들 때문입니다.

Java documentation comments - 자바 문서 주석 (javadoc)

---

컴파일러는 다중 줄 주석처럼 /** 에서 */ 까지 모든 텍스트를 무시합니다.

이러한 유형의 주석은 당신의 소스 코드에 대한 문서를 자동적으로 생성하기 위해 사용 될 수 있습니다.

주로, 이 주석은 클래스 선언 위에 위치하며, 인터페이스, 메서드 등등에 위치합니다.

@param, @return과 같은 특별한 레이블들은 종종 도구를 조종하기 위해 사용됩니다.

하지만, 이러한 레이블들은 선택적이며 이는 현재 다루지 않을 겁니다.

그저 당신이 이것들을 봤을 때, 놀라지 마세요.

밑에 예제를 볼 수 있습니다 :

class Program {
    /**
     * The main method accepts an array of string arguments
     * 
     * @param args from the command line
     */
    public static void main(String[] args){
        // do nothing
    }
}

이 문서 주석을 완벽히 이해하지 않았다고 두려워 하지 마세요.

이는 다른 주제에서 다룰 겁니다.