Hayden's Archive
[자바/Java] Javadoc 주석 본문
참고 : https://docs.oracle.com/javase/9/javadoc/javadoc.htm#JSJAV-GUID-7A344353-3BBF-45C4-8B28-15025DDCC643
Javadoc
Run the javadoc tool. You need to specify a doclet to analyze the documentation comments and any other special tags. However, if you don’t specify any doclet, by default, the Standard Doclet is included. You specify a number of command-line options, some o
docs.oracle.com
참고 : www.devkuma.com/books/pages/1231
프로그램 개발 지식 공유, devkuma
데브쿠마는 프로그래밍 개발에 대한 지식을 공유합니다.
www.devkuma.com
자바독 생성을 위한 주석 작성법
■ 주석의 개념 - 코드에 대한 개요와 코드 자체만 가지고 이용할 수 없는 추가적인 정보 제공 - 프로그램을 읽는 것과 이해하는 것에 관계된 정보만을 포함하고 있어야 한다. - 중복된 주석은 피
woonohyo.tistory.com
참고 : https://www.youtube.com/watch?v=CJxMwbJPisw
자바의 Document 형태의 문서를 만들 때 사용할 수 있는 주석을 JavaDoc 주석이라고 한다. JavaDoc 주석을 이용하면 메소드와 클래스의 용도가 무엇인지 설명을 문서로 남길 수 있다.
프로젝트에서 유용하게 활용할 수 있는 기능이다.
먼저 JavaDoc 주석은 /** 으로 시작해서 */로 닫는다. Javadoc의 주석은 설명하고자 하는 메소드나 클래스의 바로 위쪽에 작성한다.
* Javadoc 실행파일의 위치 (Java 8 기준)
C - Program Files - Java - jdk1.8.0_201 - bin - javadoc.exe
프로젝트에 doc 폴더를 만들고 Project - Generate Javadoc 실행한다.
Configure... 에서 C - Program Files - Java - jdk1.8.0_201 - bin - javadoc.exe 지정,
Use standard doclet 확인 (해당 프로젝트에 만든 doc 폴더를 선택)
next->next -> finish
그리고 나서 doc 폴더 안에 있는 index.html에서 오른쪽 마우스 클릭 후
open with - web browser 하면 이클립스 내에서 웹브라우저를 통해 문서 정보 확인
