본문 바로가기

728x90
반응형

자바 문서

[JAVA] Javadoc의 @See, @link, @inheritDoc 태그 살펴보기 Javadoc은 Java 소스 코드에서 HTML 형식의 최신 Java 문서를 생성하는 좋은 방법입니다.Javadoc 주석 중 @see, @link, @inheritDoc 태그에 대해서 알아보겠습니다.@see참조를 가리키는 링크나 텍스트 항목이 필요할 때 @see 태그를 사용합니다.이 태그는 참조에 "참조" 제목을 추가합니다. 문서 주석에는 수많은 @See 태그를 사용할 수 있습니다. 또한 모두 같은 제목으로 그룹화할수도 있습니다. Oracle 문서에서는 사용 방법에 대한 자세한 가이드를 제공합니다. 이 태그는 유효하며 패키지, 개요, 생성자, 클래스, 인터페이스를 포함한 모든 문서 주석에서 사용 가능합니다. @see 태그에는 3가지 변형이 있습니다. @See 태그의 형식@see reference @See.. 더보기
[JAVA] Javadoc란 좋은 API문서란 소프트웨어 프로젝트의 전반적인 성공에 기여하는 많은 요소들 중에 하나입니다.JDK는 소스 코드에 있는 주석에서 API 문서를 생성하는 Javadoc 도구를 제공합니다.Javadoc를 사용하기 필수 조건은 다음과 같습니다.(필수) JDK1.4 (Maven Javadoc 플러그인의 최신 버전에는 JDK7+을 권장함)(필수) PATH 환경 변수에 JDK/bin 폴더가 추가되어야 함(선택) 내장 도구가 있는 IDEJavadoc 주석Javadoc의 주석 구조는 일반적인 다중 줄 주석과 유사하지만 시작 부분에 별(*)이 하나더 추가되야 합니다.// 한줄 주석입니다./* * 일반적인 여러줄 주석(멀티 주석) 입니다. *//** * Javadoc 입니다. */ Javadoc 스타일 주석에는 HTML .. 더보기

728x90
반응형