[Java]Comments(주석)

1. End-of-line comments

// : 자바 컴파일러는 라인에서 // 뒤에 오는 텍스트는 모두 무시한다.

class Program {
    public static void main(String[] args) {
        // The line below will be ignored
        // System.out.println("Hello, World");
        // It prints the string "Hello, Java"
        System.out.println("Hello, Java"); // Here can be any comment
    }
}

2. Multi-line comments

여러 줄에 걸쳐 주석을 달려면 해당 부분을 /* 로 시작해 */ 로 끝나게 감싸면 된다.

class Program {
    public static void main(String[] args) {
        /* This is a single-line comment
        This is an example of
        a multi-line comment */
  }
}

3. Java documentation comments

자바 컴파일러는 /** 로 시작해서 */로 끝나는 텍스트는 모두 무시한다. 이런 종류의 주석은 주로 소스 코드에 대한 문서(API 문서라던지 SDK)를 작성할 때 javadoc으로 사용한다. 보통 이 주석은 class, interface, method를 선언할 때 그 위에 쓴다.

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
    }
}