javadoc이란?
인수인계를 하거나 기능을 명세할 때, 자바 소스 파일들을 문서화 할 일이 있을 수 있는데 이럴때 html 형식으로 설명, 하이퍼링크를 생성해주는 것이 javadoc이다.
자바독의 형식은 보통 위처럼 pdf로 1) 소스 파일에 대한 설명을 위해서 쓰기도하고 아니면 2) 이클립스에서 javadoc으로 export하여 html로 직접 확인할 수 있는 방법으로 쓰인다.
어노테이션(@:Annotation)에는 어떤 것들이 있는지 알아보자.
@author : 코드 소스 작성자
@deprecated : 해당 클레스(구현체)의 삭제 또는 지원이 중단되는 것을 알려줌
@exception : 예외처리할 수 있는 것들을 정의, 알파벳 순
@param : 매개변수 메서드, 생성자 설명
@return : 리턴값 설명
@see : 파일이 참조하는 다른 클래스와 메서드 등
@serial : Serializeable 인터페이스에 사용
@serialData : writeObject writeExternal 메소드로 작성된 데이터 설명
@serialField : serialPersistnetFields 모든 배열에 사용됨
@since : 해당 클래스가 추가된 버전
@throws : @exception처럼 예외처리하는 것들을 정의
@version : 구현체, 패키지 버전 명시
클래스, 메서드 작성예시
javadoc 생성방법
1) 해당 프로젝트를 우클릭한 후 Export를 누른다
2) javadoc을 검색한 후 next 클릭
3) 해당 프로젝트를 체크 후 경로 설정 후 Finish!
하이퍼링크가 처리된 html문서를 확인해보고 싶다면 프로젝트안에 생성된 doc폴더안에 index.html을 클릭하면 된다!
참고사이트:
https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html
'JAVA' 카테고리의 다른 글
mysql-connector-java 사용 및 다운로드 방법 (1) | 2021.10.28 |
---|---|
[java] hot code replace failed 에러시 해결방법 (0) | 2021.10.26 |
[자바 템플릿엔진] jsp는 이제 안녕? thymeleaf란? (0) | 2021.10.22 |
[JAVA] 정규표현식에 대해서 알아보자!(+자주쓰는 regex 이메일,주민번호 등) (0) | 2021.10.07 |
[JAVA, 자료구조] Array(배열)와 List(리스트)의 차이(+그리고 ArrayList는?) (0) | 2021.10.06 |