자바 주석 달기

//– Class comment.

 

/**

* Title : 제목 …..(Action, Dao, Dto, Form .. class)

* <p>Description : 내용 <p>

* <p>Copyright: Copyright(c) 2004 soma. All rights reserved.</p>

*

* @author YoungDae. Kim

* @version $Revision. * $

* $log : $

*

* @struts.action name=”actionForm” path=”/exemAction” scope=”request”
* @struts.action-forward name=”pass” path=”/exemAction1.do”

*

* @struts:form name=”actionForm”

*/

 

 

//– Fuction comment…

 

/**

* 함수의 내용.

*
* @param i

* @param j  //멤버 함수로 전달된 파라메터를 나타냄. 파라메터당 하나의 태그 사용.

* @exception Exception
*
* @return String k //멤버함수의 리턴값 설명. 리턴값의 타입/클래/사용처를 나타냄

*

*/

 

1) JavaDoc주석을 사용하는 경우  /** */

Interface, Class, 멤버함수와 변수 바로 위에서 선언

JavaClass의 Document를 자동 생성하여 활용하는 경우 필요한 정보를

기술한다. 작성된 Document는 이후 이해하기 쉬운 용어를 이용하여 기술한다.

2) 일반Class 주석을 사용하는 경우

코드 그 자체로 쉽게 이해할 수 없는 부분을 자세히 설명해 준다. 코드 내에서

사용되는 변수의 의미 설명을 한다

//  기본적으로 멀티라인 주석을 사용하는 것을 원칙으로 하나 임시로 사용하거나

간단한주석처리 시 사용

/* */  더 이상 적용하지 않는 코드 라인들에 코멘트처리를 하거나 Method 안의

변수 또는 코드에 주석을 달고자 할 때 사용
@ 태그
@see class_name : “See also”라는 항목을 만들어 해당 클래스와 연결해준다.
@see class_name#method_name : “See also”라는 항목을 만들어 특정 메소드와 연결해준다.
@version text : HTML 파일의 버전을 표시하는 항목을 만들어 준다.
@author text : HTML 파일의 저자를 표시하는 항목을 만들어 준다.
@param name description : 특정 메소드가 취하는 파라메터를 기술할 때 사용된다.
@return description : 특정 메소드의 리턴값을 기술할 때 사용된다.
@exception class_name : 특정 메소드가 발생시킬 수 있는 에외상황을 기술할 때 사용된다.

-. 특별하게 사용된 코드의 경우 추적의 목적으로 Space을 이용하여 그 라인 마지막에

사용한다.

if (a == 2) {

return TRUE;            /* special case */

} else {

return isPrime(a);      /* works only for odd a */

}

 

while (from > 1) {

while( to > 10 ) {

}    // from while문 close

}        // to while문 close