Eclipse 에서의 유용한 Comment Code Template 몇가지

대부분의 IDE가 그렇듯 이클립스 역시 Code Template 기능을 지원하고 있습니다.

실제 코드 라인 뿐만 아니라 각 영역별 주석에도 이를 적용 할 수 있는데, 팀 단위 개발에서는 주석에도 상당한 신경을 써야 하므로 주석에 대한 Template 을 몇가지 맞춰 두는 것도 좋은 방법이라 할 수 있겠습니다.

제가 사용하는 몇가지 Comment Template 입니다.

◈ Preference 항목

⊙ Java > Appearance > Code Template

◈ 설정 내용

⊙ Comments -> Types
/**

 * <pre>
 * ${package_name}
 *   |_ ${file_name}
 * </pre>
 * 
 * Desc : 
 * @Company : Wisenut. Inc
 * @Author  : ${user}
 * @Date    : ${date} ${time}
 * @Version : 
 */

⊙ Comments -> Constructor

/**
 * Desc : Constructor of ${file_name} class
 * ${tags}
 */

⊙ Comments -> Methods

/**
 * Desc : 
 * @Method Name : ${enclosing_method}
 * ${tags}
 */

◈ Comment 적용 하기

만들어 놓은 Comment Template을 적용하는 단축키는 [Shift] + [Alt] + [J] 입니다.
클래스 혹은 생성자나 메소드 안에서 단축키를 누르면 미리 작성해놓은 Comment Template을 기반으로 Comment 를 생성해줍니다.

1. Class Comment 적용 예

2. Constructor, Method 적용 예

이처럼 편리하게 Comment를 작성 할 수 있습니다.

◈ 추가 설정

Class Comment 를 살펴보면 ${user} 라는 변수가 있습니다.
이 User 변수는 eclipse 설정파일에 별도로 설정을 해줘야 적용되는 부분으로써 eclipse.ini 를 열어 아래와 같이 편집해야 합니다.

18번째 라인에 "-Duser.name=" 이라는 시스템 환경변수를 등록하여 사용자 이름을 추가 할 수 있습니다.

eclipse.ini 에 위 시스템 환경변수를 추가 후 eclipse 를 재시작 하면, 그 때 부터는 ${user} 변수에 자동으로 본인이 지정한 이름이 적용됩니다.

잘 되시나요? ^^