이클립스 코드 템플릿(Code Templates) 설정

이클립스 코드 템플릿(Code Templates) 설정

[Eclipse] code templates 사용법

Tool/Eclipse / 2012/03/18 12:45

   

이클립스메뉴에서
Windows > Preferences > Java > Code Style > Code Templates 를 선택하면
다음 과 같은 화면을 볼수있다.

우선 Comments 노드를 확장해보자.
무심결에 클래스나 기타 파일을 생성하면서 생기는 /** */ 형태의 javadoc주석들이 보일것이다.

Comments노드는 주석 템플릿으로서 생성자, 타입, 메소드, 오버라이드 등의 메소드의 주석 을 지정하게 된다.

Code노드는 새로운 소스를 생성하거나 catch블록, 메소드 생성, Constructor 생성등의 경우에 주석의 내용을 채우는 내용을 지정할수 있다.


먼저 Comments노드에 Methods노드를 클릭하자.

이 창에서 오른쪽에 edit라는 버튼을 클릭하여 편집해보자.
  
아래와 같이 편집 모드에서 밑에 Insert Variable..
버튼을 클릭하면 사용가능한 태그 들의 목록이 나와 선택하면 자동으로 만들어준다.

   

Code노드에 New Java files 노드를 선택후 마찬가지로 Edit버튼을 클릭하여 편집한다. 

OK를 누른후 클래스 파일을 생성하여 설정한대로 주석 템플릿이 지정되었는지 눈으로 확인할수있다.

Code노드 
 
New Java Files : 새로운 클래스나 인터페이스등을 생성할때 적용 
Catch block body : try/catch 구문 사용시 적용 
Method body : 새로운 메소드 생성시 적용 
Constructor body : 새로운 생성자 생성시 적용 
 
 그외 한번씩 적용 하다보면 별 무리 없이 익숙해지리라 생각한다.


오른쪽 import버튼을 이용하여 xml파일에 작성된 내용을 한번에 템플릿에 적용이 가능하다.

yysvip.tistory.com_codetemplates.xml

 

===========================================================================

이클립스 코드 템플릿(Code Templates)

   

Preference ->java -> code style -> code templates 에서

     

타입

     

/**
 * @클래스명 : ${type_name}
 * @작성자 : 홍길동
 * @작성일 : ${date}
 * @설명 : 
 * @수정이력 - 수정일, 수정자, 수정내용
 */ 

     

이렇게 할경우

/**
 * 
 * @클래스명 : UserMileAction
 * @작성자 : 홍길동
 * @작성일 : 2012. 03. 26
 * @설명 : 
 * @수정이력 - 수정일, 수정자, 수정내용
 */

[출처] 이클립스 코드 템플릿 Code Templates/**|작성자 꿈을먹고사는점래

출처 -  http://blog.naver.com/edp2721?Redirect=Log&logNo=50014124985

   

   

동일한 내용을 반복하는 일은 은근히 귀찮은 일이죠.
Eclipse의 Code Template을 기능을 사용하면 편리합니다.

지금 하고 있는 프로젝트에서 javadoc 생성을 위해 모든 method에 주석을 넣으라고 하더군요.
어떤 분이 Code Template을 사용하는 방법을 알려주셔서 편하게 작업할 수 있었습니다.

먼저, 이클립스를 열어서 다음 경로로 들어가 보세요.
Window > Preferences > Java > Code Style > Code Templates

Comments를 펼치세요.

     

 1. Class에 주석 넣기

Types를 클릭하면 다음과 같이 보입니다.

[Edit] 버튼을 눌러서 템플릿을 원하는 내용으로 바꾸세요.

적용을 한 후,
파일을 열어서 class 윗부분에 커서를 위치시키고
단축키 [Shift + Alt + J]를 누르시면 아래와 같이 Code Template에 등록한 주석이 나타납니다.

     

2. Method에 주석 넣기

 Methods를 클릭하면 다음과 같이 보입니다.

[Edit] 버튼을 눌러서 템플릿을 원하는 내용으로 바꾸세요.

적용을 한 후,
파일을 열어서 Method 안에 커서를 위치시키고

단축키 [Shift + Alt + J]를 누르시면 아래와 같이 Code Template에 등록한 주석이 나타납니다.

이렇게 좋은 기능이 있는데 지금까지 복사[Ctrl+C]하고 붙여넣기[Ctrl+V]했던 게 넘 억울하지 않았나요?

이외에도 이클립스에 정말 많은 좋은 기능들이 있을텐데..
앞으로 열심히 찾아볼 생각입니다.

출처 - http://zzznara2.tistory.com/75

   

   

자바독을 프로젝트 완료 후에 사용을 하건 안하건..
주석을 다는 것은 중요하다고 생각한다.

오늘 작업 내용이 몇 시간만 지나도 무슨 내용인지 잊어버리는 나같은 사람들에게는 더욱더..

적어도 메소드를 누가 언제 추가/수정 했는지, 어떤 내용인지에 대한 내용만 있어도
다른 사람, 무엇보다 나를 위해서 좋지 않을까?

코딩은 습관이라고 하는데.... 처음부터 좋은 습관이 몸에 베어 있으면 별 의식 없이 그렇게 하게 되니.. 더욱 좋을 것 같다..

그래서.....
이클립스에 주석 템플릿을 설정 할 수가 있는데....

Window > Preferences > Java > Code Style > Code Templates 에서 각각의 경우에 대하여 셋팅을 할 수가 있다.

주석에 셋팅할 내용은 본인 취향이나 목적에 따라 설정하면 되고,
내용이 사용자나 날짜 등 환경에 따라 자동으로 셋팅하고자 한다면 
입력창에 커서를 놓고 Ctrl + Space를 누르면 선택할 수 있는 값들이 나타난다.

프로젝트가 workspace에 한개라면 보통 이렇게 적용이 되지만,
저장소에서 내려받았다거나, 여러개의 프로젝트가 있는 경우라면 프로젝트 설정을 확인해야 한다.

Navigator나 Package Explorer에서 주석을 적용하고 싶은 프로젝트를 선택하고 마우스 우클릭,
Properties > Java Code Style > Code Templates
Enable project specific settings를 체크해준 후 Apply나 OK를 누르면 적용 완료!!

템플릿으로 설정한 주석을 입력하려면 입력하고자 하는 장소에서 /**을 입력하고 엔터를 누르거나
Shift + Alt + J 를 누르면 입력이 된다.

   

출처 - http://drunkenma.tistory.com/5

   

   

- 내 경우 클래스에 대한 주석, 메소드에 대한 주석 두 가지를 사용한다.

1. 설정

- Window > Preferences > Java > Code Style > Code Templates 
- Types

/**  * @FileName      : ${file_name}  * @Project     : ${project_name}  * @Date        : ${date}  * @작성자          : ${user}  * @변경이력     :  * @프로그램 설명     :  */

- Methods 

/**  * @Method Name : ${enclosing_method}  * @변경이력      :  * @Method 설명     :  * ${tags}  */

     

2. 주석 삽입하기

Alt + Shift + J :  주석 생성 - 해당 메서드/클래스에 대한 주석을 템플릿을 생성해 준다.

   

출처 - http://xyunsikx.tistory.com/4