Eclipse 주석 설정 (with Code Template)

Eclipse를 사용하며 주석을 설정하는 방법에 대해 알아보자. 

 

Eclipse Class 주석 설정

Eclipse Class 주석 설정

위와 같이 아무 클래스 선언부 위에 /** 라고 입력하고 엔터를 쳐보자. 그럼 우측과 같이 @author 가 나오면서 주석을 입력할 수 있는 공간이 생긴다. 

 

Eclipse Method 주석 설정

Eclipse Method 주석 설정

Class와 마찬가지로 Method에도 메소드 위에 /** 라고 입력하고 엔터를 쳐보면 위와 같이 param, return 등의 정보가 세팅이 되며 주석을 입력할 수 있는 공간이 생긴다. 

 

이런건 어디서 어떻게 세팅을 하는것일까? 아주 간단하게 설정이 가능하다. 

---

Eclipse 주석 설정

Eclipse 주석 설정

Eclipse 상단 메뉴 > Window > Preferences > code templates 입력 을 하면 위와 같은 화면이 보일것이다. 자바를 기준으로 설명을 진행하도록 하겠다. Java 쪽의 Code Template을 누른다. 

 

Java Code Template

Java Code Templates > Comments > Types > Edit... 를 눌러서 Class 주석에 대한 설정을 할 수 있다. 아래의 Pattern을 보면 위의 코드에서 주석을 달았을때 나온 내용이 여기에서 비롯된 것이구나 하는것을 알수 있다. 이 부분을 수정해보자. 

 

Comments for created types

원래의 주석을 이런식으로 꾸밀 수 있다. 

 

Insert Variable

여기에 위의 Insert Variable... 이라는 버튼을 눌러보면 넣을수 있는 변수값들을 확인할 수 있다. 이정도 작성하고 적용을 한 후에 다시 Class 주석을 달아보자.

 

Eclipse Class 주석

내가 바꾼대로 주석이 적용이 잘 된것을 확인할 수 있다. Class 외 다른 Type의 주석도 이와 같은 방식으로 적용하면 된다. 

 

위의 주석을 정의하며 사용한 @author, @version, @since 이 무엇인지는 다음 표를 참조하자. 

Type	@ name	Desc
class or interface	@author	저자 표시
	@version	version 정보
	@since	언제 만들었는지에 대한 정보
	@deprecated	deprecated 여부
	@see	참조할 대상이 있는 경우 링크
method	@thorws	exception 에 대한 정보
	@exception	exception 에 대한 정보
	@param	매개변수
	@retrun	return type

 

 

 

끝!