230916 (토)

1. 주석

1) 주석문

- 자바 소스에 대한 설명을 추가할 때 사용함

- 종류

* 한 줄 주석 : //

* 여러 줄 주석  /* */

 

2) Annotation

- 일반 주석문과 달리 @로 시작함

- 코드에 대한 설명보다 컴파일러에게 정보를 알려주기 위해 사용함

- 어노테이션 예제

@Override
@Deprecated
@SupressWarnings("unchecked")

 

3) API 문서작성

- 구현이 완성된 프로그램에 대한 사용설명서

- API 문서작성 방법

* 소스에서 문서 주석을 추가함

* JAVA_HOME/bin/javadoc.exe 프로그램으로 API 문서를 생성함

/**

*@문서정보 1
*@문서정보 2
*@문서정보 3
...

*/

- 문서 주석 어노테이션 종류

@author [소스 코드 작성자 이름]

@param [매개 변수에 대한 설명]

@return [반환 값에 대한 설명]

@see [참조 또는 관련 있는 클래스 표시]

@since [코드가 적용되기 시작한 버전 정보]

@throws [오류에 관한 설명]

@version [소스 코드의 버전 정보]