작성 방법

IDE

JavaDoc 작성 방법 및 IntelliJ에서 생성하기 + 모든 주석 한 번에 제거하기

JavaDoc 예시. ( 오라클 Java Se 1.8 ) docs.oracle.com/javase/8/docs/api/index.html 위와 같은 형태의 html 문서를 JavaDoc이라고 한다. .java 파일에 클래스, 필드, 메소드 등에 JavaDoc 형식에 맞춰 주석을 작성한 다음, IDE의 기능을 이용해 간편하게 JavaDoc을 생성할 수 있다. 필요성 소스 코드 내에 주석을 다는 방식을 이용할 수도 있지만 이 경우 소스 코드를 결국 눈으로 하나하나 다 찾아들어가야 한다. 숲을 한 번에 보진 못하고 나무 하나 하나에 설명을 붙여놓은 느낌이랄까.. 반면 JavaDoc 방식을 이용할 경우 전체 프로젝트 구조를 문서화 하여 Overview에 유리할 수 있다. 숲 전체의 지도를 그려서 이 구역에는 어..

리차드
'작성 방법' 태그의 글 목록