본문으로 바로가기
반응형

이클립스(Eclipse)나 STS에서 메서드나 클래스에 주석을 통해 코멘트를 작성할때 코드 템플릿(Code Template) 기능을 이용하면 자동으로 주석(Comment)를 생성하여 쉽게 작성 할 수가 있습니다. 

클래스나 메서드 생성시 적절하게 코멘트를 작성해 줘야 해당 클래스나 메서드를 사용하는 사용자가 소스를 보지 않아도 쉽게 용도를 알 수 있습니다. 이번 포스팅에서는 필자가 JAVA의 메소드(Method)와 클래스(Class)를 대상으로 주석 템플릿 설정하는 방법과 사용하고 있는 템플릿을 공유 드리도록 하겠습니다.

1. 먼저 설정 Rreferentces(⌘,) 메뉴로 들어가 Java > Code Style > Code Templates를 선택 해 줍니다.
그럼 우측에 각 속성마다 템플릿을 설정할 수 있는 목록이 뜨는데 먼저 여기서 클래스(Class)의 템플릿을 수정해보기 위하여 Type을 선택하여 더블클릭 혹은 Edit 버튼를 눌러 주세요.


2. 해당 속성의 템플릿을 편집 할 수 있는 창이 뜨는데 여기서 패키지명, 파일이름, 생성자, 날짜, 설명 등의 항목을 기재해 주도록 하겠습니다. 이때 ${package_name}, ${file_name}, ${date} 등의 템플릿 기본 변수를 적절하게 사용해 주면 일일히 클래스명등을 기재할 필요 없이 쉽게 코멘트 작성이 가능해 집니다.


3. 아래와 같은 템플릿을 설정한 뒤 주석을 생성할 클래스를 선택한 뒤  Source > Generate Element Commnet를 선택하거나 단축키(⌘+⌥+J / ALT+SHIFT+J)를 사용하여 설정한 주석(Comment)를 자동으로 생성해 줄 수 있습니다.



4. 클래스 메서드 각각 아래의 템플릿을 사용했을때 생성되는 주석 예시입니다.
Class
/**
* @packageName    : ${package_name}
* @fileName        : ${file_name}
* @author        : Jihun Park
* @date            : ${id:date('YYYY.MM.dd')}
* @description            :
* ===========================================================
* DATE              AUTHOR             NOTE
* -----------------------------------------------------------
* ${id:date('YYYY.MM.dd')}        Jihun Park       최초 생성
*/



Method
/**
* @methodName    : ${enclosing_method}
* @author        : Jihun Park
* @date        : ${id:date('YYYY.MM.dd')}
* ${tags}
*/


5. 적절하게 주석을 사용했을 경우 사용자가 아래와 같이 쉽게 해당 메서드의 설명 보고 참조 할 수 있습니다.



반응형

댓글을 달아 주세요