이클립스 주석.

보통 개발팀내나 프로젝트등에서는 개발자들의 소스 작성에 있어 여러가지 표준을 준수하도록 한다. 그중 품질관리등에 입각해 클래스나 메소드 주석에 작성자와 작성일등의 부가 정보를 필히 기술하게 하는 경우도 있다. 꼭 이런 경우가 아니더라도 나중에 javadoc 생성을 위해서라도 자바 소스내의 적절한 주석은 꼭 필요하다.

이클립스에서는 이러한 주석을 단축키등을 통해 쉽게 달수 있는 방법을 제공한다.
이클립스 메뉴의 Windows>Preferences>Java>Code Style>Code Templates 에서 원하는 형태의 주석을 만들어 입력하고 적용하면 된다.

예를들어 만약 자바 파일을 생성시 항상 맨위에 Copyright 문구등을 입력하고 Class에는 javadoc을 위한 정보를 입력한다고 하면 Code>New Java Files에 다음과 같은 형식으로 입력하면 된다

 /*
 * Copyright 2001-2004 by XXX Corp.,
 * All rights reserved.
 *
 * This software is the confidential and proprietary information
 * of XXX Corp. ("Confidential Information").
 */
${package_declaration}

/**
 * Comments here!!!
 * @author : ${user}, ${date}
 */
${typecomment}
${type_declaration}

이제 적용후 자바 파일을 새로 생성해보면 자동으로 해당 주석등이 함께 나오는것을 확인할 수 있다.

이런 경우외에도 클래스나 메소드 또는 Getter, Setter에도 원하는 형태의 주석을 설정할수 있고 이를 적용하기 위해서는 주석을 달고자 하는 클래스나 메소드명 라인에 커서를 위치하고
마우스 오른쪽 버튼을 눌러 Source>Add Comment 를 클릭하거나 단축키 Alt+Shift+J 를 누르면 자동으로 해당 부분에 설정된 주석이 추가됩니다. 또는 /** 를 입력하고 엔터를 치는 경우에도 설정된 주석이 있는 경우 자동으로 내용이 삽입됩니다.

Code Templates 설정에 사용할 수 있는 각종 내장 변수는 ${}형태로 기술하면 되며 Edit Templates창에서 Insert Variables 버튼을 클릭해 삽입할수도 있다

• bare_field_name : get,set 메소드에서 get/set등을 제외한 필드명
• date : Current date (현재 날짜)
• dollar : The dollar symbol (달러문양)
• enclosing_type :The type enclosing the method (선택된 메소드의 타입)
• file_name : Name of the enclosing compilation (선택된 편집파일 이름)
• package_name : Name of the enclosing package (선택된 패키지 이름)
• project_name : Name of the enclosing project (선택된 프로젝트 이름)
• tags : Generated Javadoc tags (@param, @return...) (Javadoc 태그 생성)
• time : Current time (현재 시간)
• todo : Todo task tag ('해야할일'태그 생성)
• type_name : Name of the current type (현재 타입의 이름)
• user : User name (사용자 이름)
• year : Current year (현재 연도)

[출처] http://powerjava.net/blog/soulcarta/entry/이클립스내-주석-자동-달기
[Soulcarta's Home]