[Java] 프로젝트 개발 문서 (javadoc)

Programming/Java

[Java] 프로젝트 개발 문서 (javadoc)

Isaac S. Lee 2023. 8. 25. 17:43

자바에서 프로젝트를 진행하면서 산출물 중, 다른 사람들이 코드를 알아보기 위한 도움말, 개발 문서(Documentation)을 만들어야 한다.

JDK의 javadoc.exe 기능을 이용해 개발 문서를 만들 수 있다.

Project

Main Class

package com.test.main;

//메인 클래스
/*
 * 다중 주석
 */

/**
 * 메인 클래스
 * 프로젝트 메인 역할을 하는 클래스입니다.
 * @author Isaac
 */

public class Main {

	// 메인 메소드
	// 프로그램 시작점
	
	/**
	 * 메인 메소드
	 * 프로그램의 시작을 담당합니다.
	 * @param args 메인 인자
	 */
	public static void main(String[] args) {
		
		// 도움말 > Documentation
		// - JDK > javadoc.exe
		
	}
}

View Class

package com.test.main;

/**
 * 출력 클래스입니다.
 * 화면상의 모든 출력과 관련된 기능을 제공합니다.
 */
public class View {

	/**
	 * 주요 제목을 출력합니다.
	 * @param title 제목 문자열
	 */
	public void title(String title) {
		
	}
	
	/**
	 * 보조 제목을 출력합니다.
	 * @param subTitle 보조 제목 문자열
	 */
	public void subTitle(String subTitle) {
		
	}
	
	/**
	 * 프로그램을 일시 정지합니다.
	 */
	public void pause() {
		
	}
}

Data Class

package com.test.main.repository;

/**
 * 프로젝트의 데이터를 조작하는 클래스입니다.
 */
public class Data {

	/**
	 * 파일의 내용을 컬렉션으로 저장합니다.
	 */
	public static void load() {
		
	}
	
	/**
	 * 컬렉션의 데이터를 파일로 저장합니다.
	 */
	public static void save() {
		
	}
	
	/**
	 * 전체 데이터 개수를 반환합니다.
	 * @return 전체 데이터 개수
	 */
	public int getCount() {
		return 10;
	}
}

이와 같은 프로젝트가 있다고 가정해보자.

클래스와 public을 가지는 메소드 위에 설명(도큐먼트 주석)을 작성하였다.

도큐먼트 주석은 해당 기능을 사용하려고 할 때 도움말로 나타나며, 해당 기능이 어떤 기능을 가지고 있는지 알 수 있게 해준다.

Export > Javadoc

먼저 javadoc.exe가 선택되어 있는지 확인한다.

만약 선택되어 있지 않다면 javadoc.exe가 있는 폴더 경로를 찾아 입력한다.

보통 도움말이라는 건 사용하는 사람이 보는 것인데, 주로 public이 보이고 나머지 기능은 보이지 않기 때문에 현업에서는 4가지 버전(Private, Package, Protected, Public)을 모두 달기도 하지만, 현재는 약식으로 Public에만 만드는 걸로 한다.