[IntelliJ] 주석 템플릿 생성 후 사용하기

 

 

주석은 보통 해당 위치의 소스코드에 대한 설명이나 부가적인 설명을 위해,
혹은 소스코드에서 잠시 제외시키기 위하여 사용합니다.

아래와 같은 일정한 형태의 주석을 지속적으로 사용할 경우에는
매번 작성하기 번거로울 수 있습니다. 

 

/**
 * 
 * 메인 컨트롤러
 * 
 * @author 무사뎀벨레
 * @version 1.0.0
 * @date 2022.08.03
 *
 **/

 

그렇기 때문에 자주 사용하는 주석의 템플릿을 미리 등록시켜,
사용할때마다 단축키를 이용하여 사용할 수 있습니다.

 

 

 

 

 

 

 

1. 주석 템플릿 등록하기

---

 

1) 인텔리제이 상단 메뉴바의 File ->  Settings.. 를 클릭하여 설정 화면에 진입합니다.(키보드 단축키 Ctrl + Alt + s)

2) 왼쪽 메뉴바에서 Editor -> Live Templates를 선택합니다.

3) 오른쪽의 + 아이콘을 클릭하여 2. Template Group... 을 선택합니다.

 

 

4) Create New Group 창 안쪽에 등록할 템플릿의 이름을 입력한 뒤 OK 버튼을 클릭합니다.

 

 

5) 생성한 템플릿을 선택한 뒤 오른쪽의 + 아이콘을 클릭하여 1. Live Template 를 선택합니다.

 

 

6) 탬플릿 정보를 입력합니다.

Abbreviation : 주석 명칭

Description : 주석 설명

Template text : 주석 템플릿 내용

 

아래 화면을 보면 Template text 입력 칸에 아래 항목과 같이 $ 기호로 둘러 쌓인 것들을 확인할 수 있는데, 이것들은 변수 처리할 부분들입니다.

$class$

$user$

$date$

 

7) 위 항목들을 입력한 뒤에 Edit variables 버튼을 클릭하여 변수 처리한 항목을 설정합니다.

 

아래 화면과 같이 앞서 설정한 변수처리 부분들에 들어갈 값을 설정해주는 단계입니다.

각각의 변수마다 Expression 항목에 알맞은 값을 넣어주면 됩니다.

class변수엔 className(), user변수에는 user(), date변수엔 date() 를 선택합니다.

Skip id defined 항목은 체크한 뒤 OK 버튼을 클릭합니다.

 

8) 창 아래쪽에 No applicable contexts. 문장 옆에 Define 을 클릭합니다.

Define 을 클릭 후 Java 하위의 Comment, Declaration 을 체크합니다.

 

 

 

창 아래 Applicable in Java: declaration, comment. 문장, 그 옆 change 단어를 확인한 뒤 OK 버튼을 클릭하여 설정을 마무리합니다.

 

 

 

 

 

2. 등록한 주석 템플릿 사용하기

---

1) 주석을 사용하려는 곳에 마우스 커서를 위치한 뒤 키보드의 Ctrl + j 를 누른 뒤 생성한 템플릿을 선택합니다.

 

2) 아래와 같이 등록한 템플릿이 노출됩니다.

만약 등록한 템플릿이 보이지 않는다면, 인텔리제이를 재시작해보시면 됩니다.