JAVADOC 이란 | 데이터카페

JAVADOC 이란
Javadoc은 Java 프로그래밍에서 소스 코드 주석으로부터 문서를 생성하는 도구입니다. 개발자는 코드의 클래스, 메소드, 변수 등에 대해 자세한 정보를 제공할 수 있습니다. Javadoc에 관련된 주요한 내용은 다음과 같습니다:

Javadoc 주석은 /**로 시작하고 */로 끝납니다.
Javadoc 주석은 클래스, 메소드 또는 변수 선언 전에 추가하여 문서화합니다.
Javadoc 주석은 구성 요소의 설명, 목적, 매개변수, 반환 값 및 발생할 수 있는 예외 등을 포함해야 합니다.
Javadoc은 @param, @return, @throws, @see 등과 같은 다양한 태그를 지원하여 문서에 구조와 추가 정보를 추가할 수 있습니다.
Javadoc 문서를 생성하기 위해 javadoc 명령줄 도구나 Javadoc 생성을 지원하는 통합 개발 환경(IDE)을 사용할 수 있습니다.
생성된 Javadoc 문서는 일반적으로 HTML 형식으로 제공되며, 탐색 가능한 API 참조, 클래스 계층 구조 등의 관련 정보를 포함합니다.


JAVADOC 태그 



@author
코드 소스 작성자


@deprecated
해당 클레스(구현체)의 삭제 또는 지원이 중단되는 것을 알려줌


@exception
예외처리할 수 있는 것들을 정의, 알파벳 순


@param
매개변수 메서드, 생성자 설명


@return
리턴값 설명<


@see
파일이 참조하는 다른 클래스와 메서드 등


@serial
Serializeable 인터페이스에 사용


@serialData
writeObject writeExternal 메소드로 작성된 데이터 설명


@serialField
serialPersistnetFields 모든 배열에 사용됨


@since
해당 클래스가 추가된 버전


@throws
@exception처럼 예외처리하는 것들을 정의


@version
구현체, 패키지 버전 명시