언어/Java

문서용 주석 document comment

sector 2023. 7. 28. 17:32

 

 

/** 문서용 주석 document comment
* 사용설명서
* 메소드 위에 작성
*/

 

※ 사용설명서 문서로도 작성함
    문서를 만드려면 document comment가 필요하다
    프로젝트 중에서도 document comment 써야하는 프로젝트가 있고 아닌것도 있다

마우스 올리면 메서드의 사용설명서가 나온다

※ 작성한 문서용 주석 문서로 내보내는 법

추출하려는 클래스 우클릭, 패키지 전체를 선택해도 가능
JRE버전 확인 및 인코딩

VM options 에 넣기 : -locale ko_KR -encoding UTF-8 -charset UTF-8 -docencoding UTF-8

index.html 실행하면 된다
작성한 문서용주석이 정리되서 나옴