1.주석문(그 소스에 대한 설명을 개발자가 나중에 참고를 하기 위한 목적 유지보수하기 편하기 위함)
- 자바 소스에 대한 설명을 추가할 때 사용함
- 종류
한 줄 주석 | // |
여러 줄 주석 | /**/ |
2. Annotation (컴파일러한테 우리가 자바 소스를 만들고 그리고 실행하기 위해서 컴파일을 해야하는데 컴파일러에게 어떠한 정보를 알려주기 위해서 사용하는게 어노테이션)
-일반 주석문과 달리 @로 시작함
- 코드에 대한 설명보다 컴파일러에게 정보를 알려주기 위해 사용함
- 어노테이션 예제(아래 예제는 컴파일러가 이미 어떤 의미인지를 알고 있다)
@Overiide
오버라이드 란? 어떤 메소드 선언할때 내가 어떤 부모로 부터 가져온 메소드야
라고 이야기 해주는것, 만약에 그런 메소드가 아닌데 오버라이드라는 어노테이션을 썼다 그러면
컴파일러가 에러를 띄운다
@Deprecated
@SuppressWarnings("unchecked")
3. API문서작성 (내가 너무나 자바소스 파일을 잘 만들었다고 생각해서 이거를 여러사람이 사용할 수 있게끔 배포를 하고싶은데 그럴때 소스파일을 배포하지 않고 .JAVA 소스인 얘를 컴파일해서 나온 클래스파일 즉 바이트 코드로 되어있는 그 클래스 파일을 배포를 하는데, 일반인들은 사용할 수 없기 때문에 별도 문서로 내가만든 클래스에 대한 설명을 해줘야 하는데 그걸 API문서라고 한다)
- 구현이 완성된 프로그램에 대한 사용설명서
- API 문서작성 방법
(1) 소스에서 문서 주석을 추가함
(2) JAVA_HOME/bin/javadoc.ext 프로그램으로 API 문서를 생성함 ( API문서는 만들어주는 프로그램이 따로 있는데 그게 바로 javadoc 자바독 을 이용해서 쉽게 만들어 줄 수 있다)
- 문서 주석 표시 방법 (대신에 API 문서를 만들기 위해 사용할 내용들을 소스안에 넣어야 한다
어노테이션 이용해서 문서정보 넣기)
/**
*@ 문서정보1
*@ 문서정보2
*@ 문서정보3
...
*/
4. 문서 주석 어노테이션 종류
@author |
소스 코드 작성자 이름 |
@param | 매개 변수에 대한 설명 |
@return | 반환 값에 대한 설명 |
@see | 참조 또는 관련 있는 클래스 표시 |
@since | 코드가 적용되기 시작한 버전 정보 |
@throws | 오류에 관한 설명 |
@version | 소스 코드의 버전 정보 |
'JAVA' 카테고리의 다른 글
조건문 if문 (0) | 2023.02.05 |
---|---|
조건문 (0) | 2023.02.05 |
제어문의 활용 반복문 중첩 구구단 출력 (0) | 2023.01.30 |
제어문의 활용 if문 중첩 (0) | 2023.01.30 |
반복문 제어 Continue 문 (0) | 2023.01.29 |