프로그램을 제작하고 그에 해당하는 문서를 제작하는 방법으로

자바에서는 javadoc 라는 유틸리티를 제공하고 javadoc은 API Document를 생산을 낼 수 있습니다.

그래서 간단하게 API 문서를 만드는 법에 대하여 소개하겠습니다.


-- source file

* 프로그램을 제작시에 Comment 처리를 아래와 같은 형식으로 해 주셔야
  API문서를 좋더 보기 좋게 만들수 있습니다.

/**
  * "KSC5601" code를 "8859_1" code로 encoding
  * @param ko KSC5601 code String
  * @return 8859_1 code String
*/

Han.java

package ihelpers.util;
import java.io.*;

/**
* 한글 처리 모듈
*/

public class Han {

private static final boolean NO_CONVERT = true;

/**
* "KSC5601" code를 "8859_1" code로 encoding
* @param ko KSC5601 code String
* @return 8859_1 code String
*/
public static String toEng(String ko) throws Exception {
return toEng(ko,NO_CONVERT);
}

/**
* "KSC5601" code를 "8859_1" code로 encoding
* @param ko 8859_1 code String
* @param convert true/false
* @return KSC5601 code String
*/
public static String toEng(String ko,boolean convert) throws Exception {
if(convert){
if(ko == null){
return null;
}

String new_str = null;

try {
new_str = new String(ko.getBytes("KSC5601"),"8859_1");
} catch(UnsupportedEncodingException ex){
throw new Exception(ex.getMessage());
}
return new_str;
} else {
return ko;
}
}

/**
* "8859_1" code를 "KSC5601" code로 encoding
* @param ko 8859_1 code String
* @return KSC5601 code String
*/
public static String toKor(String en) throws Exception {
return toKor(en,NO_CONVERT);
}

/**
* "8859_1" code를 "KSC5601" code로 encoding
* @param ko 8859_1 code String
* @param convert true/false
* @return KSC5601 code String
*/
public static String toKor(String en,boolean convert) throws Exception {
if(convert){
if(en==null){ return null; }
String new_str = null;

try {
new_str = new String(en.getBytes("8859_1"),"KSC5601");
} catch(UnsupportedEncodingException ex){
throw new Exception(ex.getMessage());
}
return new_str;
} else {
return en;
}
}
}

-- JavaDoc Usage

API 문서를 제작하기 위해서는 아래와 같이 3가지의 파일이 필요합니다.

- makedoc.bat
- options
- packages

javadoc 의 option에 해당하는 것은 opitons 파일에서 관리를 해 주고,
추가된 package에 대하여는 packages 파일에 추가하시면 됩니다.


-- makedoc.bat file
javadoc @options @packages

-- options file
-d d:\javadoc\doc
-splitindex
-windowtitle 'iHelpers API Specification'
-bottom 'Copyright ⓒ 2001 iHelpers. All Rights Reserved.'
-sourcepath d:\javadoc
-charset euc-kr

-- packages file
ihelpers.util


실행 : d:>makedoc.bat


JavaDoc에 대한 자세한 내용은 다음 사이트를 참고해 주세요.

http://java.sun.com/j2se/1.4/docs/tooldocs/solaris/javadoc.html