====== javadoc에서 인식되는 스타일로 주석 달기 ====== * From : [[http://blog.bagesoft.com/465|바게의 열린공간]] ===== 주석양식 ===== - JavaDoc주석을 사용하는 경우 /** */ * Interface, Class, 멤버함수와 변수 바로 위에서 선언 * JavaClass의 Document를 자동 생성하여 활용하는 경우 필요한 정보를 기술한다.\\ 작성된 Document는 이후 이해하기 쉬운 용어를 이용하여 기술한다. - 일반Class 주석을 사용하는 경우 * 코드 그 자체로 쉽게 이해할 수 없는 부분을 자세히 설명해 준다. 코드 내에서 사용되는 변수의 의미 설명을 한다 * // : 기본적으로 멀티라인 주석을 사용하는 것을 원칙으로 하나 임시로 사용하거나 간단한주석처리 시 사용 * /* */ : 더 이상 적용하지 않는 코드 라인들에 코멘트처리를 하거나 Method 안의 변수 또는 코드에 주석을 달고자 할 때 사용 ===== 파라미터 사용법 ===== /** * @param name description : 특정 메소드가 취하는 파라메터를 기술할 때 사용된다. * @return description : 특정 메소드의 리턴값을 기술할 때 사용된다. * @exception class_name : 특정 메소드가 발생시킬 수 있는 에외상황을 기술할 때 사용된다. * @see class_name : "See also"라는 항목을 만들어 해당 클래스와 연결해준다. * @see class_name#method_name : "See also"라는 항목을 만들어 특정 메소드와 연결해준다. * {@link class_name#member label} : 메소드나 필드의 상호 참조에 대한 링크를 표시 * * @version text : HTML 파일의 버전을 표시하는 항목을 만들어 준다. * @author text : HTML 파일의 저자를 표시하는 항목을 만들어 준다. */ ===== 사용 예 ===== /** * String 에 관련된 Util 클래스 * @version : 1.0 * @author : kim jeng soon (newtake@naver.com) */ public class StringUtils{ /** * 문자를 replace합니다. * @param str - 문자 * @param pattern replace전 문자 * @param replace replace후 문자 * @return 바꿔진 문자 */ public static String replace(String str, String pattern, String replace) { int s = 0; int e = 0; StringBuffer result = new StringBuffer(); while ((e = str.indexOf(pattern, s)) >= 0) { result.append(str.substring(s, e)); result.append(replace); s = e + pattern.length(); } result.append(str.substring(s)); return result.toString(); } } /** * Title : 제목 .....(Action, Dao, Dto, Form .. class) *

Description : 내용

*

Copyright: Copyright(c) 2004 soma. All rights reserved.

* * @author Jaehak. Hwang * @version $Revision. * $ * $log : $ * * @struts.action name="actionForm" path="/exemAction" scope="request" * @struts.action-forward name="pass" path="/exemAction1.do" * * @struts:form name="actionForm" */
===== 유의사항 ===== * method 상단에 /** ... */가 들어가면 javadoc 대상이 된다. * 자동 문서화된 페이지에서 줄바꿈을 하려면
태그를 사용해야한다. * 주석 작성시, 다른 클래스를 참조할 경우 {@link} 를 사용한다. * 주석에서 code를 넣어야할 경우,
 태그를 사용한다.