[Eclipse] Code Template 등록 및 실행 방법

Eclipse 또는 STS에서 프로그램 소스코드에 프로그래머의 설명 등을 작성할 수 있습니다.

 

이를 주석(Comment)이라고 합니다. 

 

코드 템플릿(Code Templates) 기능을 이용하여 주석을 설정할 수 있습니다.

 

이 글에서는 Class 주석 등록 및 실행 방법에 대해서만 작성하였지만 설정 단위별로 수정 등록하여 사용할 수 있습니다.

 

[Class 주석 등록 및 실행 방법]

1. Window > Preferences > Java > Code Templates > Type 선택

2. [Edit...] 또는 [Import]를 통해 수정합니다. 

3. ['/**' + Enter] 또는 [Shift + Alt + J] 누르면 등록한 주석이 생성됩니다.

 

- ${user}의 경우 OS user name이 적용됩니다. 이를 변경하려면 Eclipse 또는 STS 설치된 경로의 설정 파일에 가서 [.ini] 파일에서 아래와 같이 추가하면 됩니다.

-Duser.name="username"

- [Export...] 기능을 이용하여 Code Template을 [.xml] 형태로 저장하여 다른 이에게 공유할 수 있습니다.

 

 

 

[설정단위]

- Files : 파일에 적용되는 주석 템플릿, Java/Jsp 같은 파일의 맨 위에 생성

- Types : 클래스에 적용되는 주석 템플릿, Class명 바로 위에 생성

- Fields : 필드(변수)에 적용되는 주석 템플릿

- Constructors : 생성자에 적용되는 주석 템플릿

- Methods : 메소드에 적용되는 주석 템플릿

- Overriding Methods : Overriding 되는 메소드에 적용되는 주석 템플릿

- Delegate Methods : Delegate 되는 메서드에 적용되는 주석 템플릿

- Getters : Getter에 적용되는 주석 템플릿

- Setters : Setter에 적용되는 주석 템플릿

 

 

[Import 경우 설정파일 예시]

codetemplates.xml

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<templates><template autoinsert="false" context="typecomment_context" deleted="false" description="Comment for created types" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">
/**
 * @packageName : ${package_name}
 * @fileName    : ${file_name}
 * @author      : ${user}
 * @date        : ${id:date('YYYY.MM.dd')}
 * @description : 
 * ==================================================
 * Date           Author           Note
 * ==================================================
 * ${id:date('YYYY.MM.dd')}     ${user}         Initial creation
 */
 </template></templates>

 

[참고사이트]

점프 투 자바 : 02-2 주석

https://wikidocs.net/260