Java기초(4) 주석 사용방법

주석은 소스코드에 설명을 남기기위해 작성한다.

예를 들어 

System.out.println(); 문장을 출력한다.

라고 작성하면 에러가 발생한다.  문장을 출력한다.라는 문장을 소스코드로 인식하기 때문이다

문장을 컴파일러가 소스코드로 인식하지 않게 하기 위해서 주석 사용방법이 따로 존재한다.

소스코드에 주석을 작성하는 방법을 알아보자

 

 

 

우선 주석에는 3가지 종류의 주석이 있다.

행 주석

범위 주석

도큐먼트 주석

이렇게 3가지가 있다.

행 주석의 경우에는 특정 행 하나만 주석처리한다.

범위 주석은 선택한 범위를 주석처리한다.

도큐먼트 주석은 해당 함수의 사용방법을 남기는 주석이다.

 

 

 

//로 작성된 부분은 행 주석이다.

/* 내용 */ 으로 작성된 부분은 범위 주석이다.

System.out.println(/**/123123); //가능하다

System.out.println(11/**/11); //불가능하다

System.out.println(/**/123123);도 불가능할 줄 알았는데 가능하다는 것을 이번에 포스팅을 하다가 알게 됐다.

 

 

 

이제 도큐먼트 주석에 대해서 알아보자

도큐먼트 주석문은 /** 내용 */  으로 작성된다.

getNowDate라는 함수에 문서 주석을 작성했다.

이 주석을 왜 사용하는지를 알아야한다

이렇게 작성을 해놓고 문서화 프로그램을 실행하면 해당 주석이 문서로 남는다.

그리고 개발 과정에서는 아래 첨부한 사진과 같이 사용할 수 있다.

 

 

 

도큐먼트 주석이 작성된 함수를 호출하면 

주석의 내용이 보인다. 그 함수가 무엇을 하는지 설명을 바로 볼 수 있는 것이다.

도큐먼트 주석을 작성해놓으면 개발할 때 유용하게 사용할 수 있다.