language:java:javadoc
차이
문서의 선택한 두 판 사이의 차이를 보여줍니다.
language:java:javadoc [2013/06/07 18:05] – 새로 만듦 kieuns | language:java:javadoc [2024/04/23 22:44] (현재) – 바깥 편집 127.0.0.1 | ||
---|---|---|---|
줄 1: | 줄 1: | ||
+ | ====== javadoc에서 인식되는 스타일로 주석 달기 ====== | ||
+ | * From : [[http:// | ||
+ | |||
+ | ===== 주석양식 ===== | ||
+ | |||
+ | - JavaDoc주석을 사용하는 경우 | ||
+ | * Interface, Class, 멤버함수와 변수 바로 위에서 선언 | ||
+ | * JavaClass의 Document를 자동 생성하여 활용하는 경우 필요한 정보를 기술한다.\\ 작성된 Document는 이후 이해하기 쉬운 용어를 이용하여 기술한다. | ||
+ | - 일반Class 주석을 사용하는 경우 | ||
+ | * 코드 그 자체로 쉽게 이해할 수 없는 부분을 자세히 설명해 준다. 코드 내에서 사용되는 변수의 의미 설명을 한다 | ||
+ | * < | ||
+ | * < | ||
+ | |||
+ | ===== 파라미터 사용법 ===== | ||
+ | |||
+ | <code java> | ||
+ | /** | ||
+ | * @param name description : 특정 메소드가 취하는 파라메터를 기술할 때 사용된다. | ||
+ | * @return description : 특정 메소드의 리턴값을 기술할 때 사용된다. | ||
+ | * @exception class_name : 특정 메소드가 발생시킬 수 있는 에외상황을 기술할 때 사용된다. | ||
+ | * @see class_name : "See also" | ||
+ | * @see class_name# | ||
+ | * {@link class_name# | ||
+ | * | ||
+ | * @version text : HTML 파일의 버전을 표시하는 항목을 만들어 준다. | ||
+ | * @author text : HTML 파일의 저자를 표시하는 항목을 만들어 준다. | ||
+ | */ | ||
+ | </ | ||
+ | |||
+ | ===== 사용 예 ===== | ||
+ | |||
+ | <code java> | ||
+ | /** | ||
+ | * String 에 관련된 Util 클래스 | ||
+ | * @version : 1.0 | ||
+ | * @author | ||
+ | */ | ||
+ | public class StringUtils{ | ||
+ | /** | ||
+ | * 문자를 replace합니다. | ||
+ | * @param str - 문자 | ||
+ | * @param pattern | ||
+ | * @param replace | ||
+ | * @return 바꿔진 문자 | ||
+ | */ | ||
+ | | ||
+ | int s = 0; | ||
+ | int e = 0; | ||
+ | StringBuffer result = new StringBuffer(); | ||
+ | while ((e = str.indexOf(pattern, | ||
+ | | ||
+ | | ||
+ | s = e + pattern.length(); | ||
+ | } | ||
+ | result.append(str.substring(s)); | ||
+ | return result.toString(); | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | <code java> | ||
+ | /** | ||
+ | * Title : 제목 .....(Action, | ||
+ | * < | ||
+ | * < | ||
+ | * | ||
+ | * @author Jaehak. Hwang | ||
+ | * @version $Revision. * $ | ||
+ | * $log : $ | ||
+ | * | ||
+ | * @struts.action name=" | ||
+ | * @struts.action-forward name=" | ||
+ | * | ||
+ | * @struts: | ||
+ | */ | ||
+ | </ | ||
+ | |||
+ | ===== 유의사항 ===== | ||
+ | |||
+ | * method 상단에 /** ... */가 들어가면 javadoc 대상이 된다. | ||
+ | * 자동 문서화된 페이지에서 줄바꿈을 하려면 <br/> 태그를 사용해야한다. | ||
+ | * 주석 작성시, 다른 클래스를 참조할 경우 {@link} 를 사용한다. | ||
+ | * 주석에서 code를 넣어야할 경우, <pre> 태그를 사용한다. |