본문 바로가기
language/java

javadoc 활용(클래스 문서화 시키기) & jar 활용(압축 및 배치)

by vamalboro 2008. 1. 20.

javadoc 활용(클래스 문서화 시키기)

package LBH.Exam02;           <패키지 이름> (import LBH.Exam02.*;) < 이런식으로 import 사용

/**                  <클래스 머릿말(클래스 설명)>
* <b>현재 클래스</b>는<h1><code>Object</code></h1>클래스를<i>상속</i>받은 클래스입니다.
* <code>toString()</code>을 재정의합니다.<br>
* <img src="doc-file/Exam02_01.gif">       <HTML 태그 가능>
* <p>
* @author 이범희                                    <@뒤에 명령어>
* @version 1.1
* @since 2008.01.
* @see Exam02_01
*/
<각 필드 & 메서드 바로위에 주석문을 달면 자동으로 설명이 만들어진다.>
public class Exam02_01 extends Object {
 /**
 * 이 필드는 문자열을 저장합니다.
 */
 private String str;
 /**
 * 이 생성자는 디폴트 생성자로 Hello I/O를 str필드에 대입합니다.
 */
 public Exam02_01() {
  this.str = "Hello I/O";
 }
 /**
 * 이 생성자는 문자열을 받아들여... 매개변수로 사용됩니다.
 * @param str 문자열을 현재의 멤버 변수 this.str에 넘겨줍니다.     <@param str 매개변수 설명>
 * @exception 없습니다.                                                          <예외 설명>
 */
 public Exam02_01(String str) {
  this.str = str;
 }
 /**
 * 현재 클래스의 문자를 리턴합니다.
 * @return String 리턴...                                                           <return 설명>
 */
 public String toString() {
  return str;
 }
}


javadoc 사용시 명령어 & 옵션 예)

javadoc -author -version -use -J-Xmx80m -d .\docs 파일명
(-d .\docs => 현재 디렉토리 하위에 docs디렉토리에 문서들을 만듬)




////////////////////////////////////////////////////////////////////////////////////////////




jar 활용(압축 및 배치)

doc문서들과 class파일 및 기타 파일들을 jar로 압축한다.
(클래스 파일이 있는 디렉토리에서 실행)
jar cvf jar02.jar *.*                 <c = 생성>
jar uvf jar02.jar *.*                 <u = 다시 생성>

jar xvf jar02.jar                      <x = 해제>


압축후 jar 파일을 jdk가 설치된 폴더의 jre\lib\ext 폴더안에 복사한다.
(위 폴더경로는 기본 클래스 패스 경로이다.)

'language > java' 카테고리의 다른 글

java.mail패키지를 이용한 JSP페이지에서 SMTP서버 메일 전송  (0) 2008.04.18
exe 파일 만들기  (0) 2008.02.12
Algorism의 복잡도  (0) 2008.01.21
I/O의 기본 개념 & Stream  (0) 2008.01.21
java.io.*;  (0) 2008.01.20