자바 - 주석

Java 주석은 이름에서 알 수 있듯이 여러 가지 이유로 프로그램에서 작성한 메모입니다. 

예를 들어, 다음에 주석을 쓸 수 있습니다.

• 변수, 방법, 클래스 또는 모든 진술에 대한 정보 또는 설명을 작성
• Java docs에서 사용할 수 있도록 텍스트를 작성
• 특정 시간 동안 프로그램 코드 숨기기

Java 주석 유형

Java에는 세 가지 유형의 주석이 있습니다.

1. 한 줄 주석
   주석을 한 행으로 만 쓸 수있는 경우 한 줄 주석을 사용하십시오.

//Initialize the counter variable to 0

int counter = 0;

2. 여러 줄 주석
   한 줄 이상을 초과하는 정보를 소스 코드에 추가해야하는 경우 여러 줄 주석을 사용하십시오.

/*

 * This function return a variable which shall be used as counter for any loop.

 * Counter variable is of integer type and should not be reset during execution.

 */

public int getCounter() {

    //

}

3. 문서 코멘트
   설명서 주석은 javadoc도구로 정보를 표시하고자 할 때 사용됩니다 . 이것은 자동 완성 기능을 사용할 때 편집기 에서 볼 수있는 정보입니다.
   문서 주석은 시작 /**로 시작하고하고 */로 끝납니다 .
   javadoc이러한 주석 내부에 주석 을 사용할 수 있습니다

/**

  * This function return a variable which shall be used as counter for any loop.

  * Counter variable is of integer type and should not be reset during execution.

  * @param seed - initial value of counter

  * @return counter value

  */

public int getCounter(int seed) {

    //

}