코드 테플릿을 활용한 주석달기

코드 테플릿을 활용한 주석달기

출처 : http://beakpro.tistory.com/219

퍼온 내용이므로 문제가 되면 삭제하겠습니다. ㅎ

프로젝트마다 약속한 주석형태를 

사용하고 있으나,

다른파일의 주석을 복사하거나

팀원들마다 다르게 작성하는

경우가 많이 있습니다.

이클립스에서 제공하는 코드템플릿을

사용하여 클래스나 메소드 등

주석을 지정해놓고 xml파일을 공유하여

단축키만으로 쉽게 

주석을 추가할수 있습니다.

(주석뿐만아니라 코드설정도 가능합니다.)

Code Template 설정하기

(1)

window - Preferences

java - Code Templates 선택 후

오른쪽 Comment에서

주석을 지정할 단위를 선택한 뒤

Edit 버튼을 클릭합니다.

(2)

pattern에 지정할 주석 양식을 입력합니다.

${file_name}와 같이 변수를 입력하면

실제 파일명 등으로 치환됩니다.

하단에 Insert Variable을 통해

날짜, 사용자 등 변수를

지정할 수 있습니다.

지정이 완료되면 OK버튼을 눌러

설정을 완료합니다.

설정한 주석 사용하기

(1)

주석을 입력할 부분에

커서를 위치한 뒤

Shift + alt + J

단축키를 입력합니다.

지정한 주석이 입력되었습니다.

패키지명, 파일명, 날짜, 사용자 등

자동으로 치환해주기 때문에

매우 편리합니다.

사용자명 변경방법

${user}를 사용할 경우 기본적으로

윈도우에 저장된 사용자명을

가져옵니다.

이를 변경하고 싶으신 경우에는

eclipse.ini 파일에 

Duser.name = “사용자명”

을 추가하시면 됩니다.

팀내 공유

Code Templates 설정 후

Export를 누르면 xml파일로 저장되며

해당파일을 svn등으로 공유하여

import하면 공유가 가능합니다.

(참고)Comment 설정단위

Files

  File에 적용되는 주석 템플릿, 

Java/Jsp등 파일의 맨위에 생성

Types

  Class에 적용되는 주석 템플릿, 

Class명 바로 위에 생성

Fields

  변수에 적용되는 주석 템플릿

Constructors

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

Methods

  메서드에적용되는 주석 템플릿

Overriding Methods

  오버라이딩메서드에 적용되는 주석 템플릿

Delegate Methods

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

Getters

  Getter에 적용되는 주석 템플릿

Setters

  Setter에 적용되는 주석 템플릿