DEV&OPS/Java

인텔리제이 주석 템플릿 설정

ALEPH.GEM 2026. 7. 6. 20:59
728x90

주석 템플릿은 크게 두 가지로 나눌 수 있습니다.

1. 파일 헤더 템플릿: 새 파일(클래스)을 만들 때 상단에 자동으로 생성되는 주석입니다.

2. 라이브 템플릿: 코드 중간에 단축키로 미리 정의된 주석 블록을 삽입하는 기능입니다.

 

파일 헤더 템플릿 설정

새 파일(클래스, 인터페이스)을 만들 때 주석을 자동으로 상단에 추가해주는 기능을 설정해봅시다.

 

  • 설정(Settings/Preferences) 열기:
    • Windows/Linux: File > Settings (단축키: Ctrl + Alt + S)
    • macOS: IntelliJ IDEA > Preferences (단축키: Cmd + ,)
  • 템플릿 위치로 이동: Editor > File and Code Templates 로 이동합니다.
  • File Header 수정:
    • 가운데 탭에서 Includes 탭을 선택합니다.
    • File Header 항목을 선택합니다. (이 템플릿은 Class, Interface, Enum 등 다른 템플릿에서 공통으로 사용됩니다.)
  • 템플릿 코드 작성: 오른쪽 편집기 창에 원하는 주석 템플릿을 입력합니다. 

 

/**
 * @author  ${USER}
 * @since   ${DATE}
 * @file    ${FILE_NAME}
 * @description 
 */

 

 

라이브 템플릿 설정

예를 들어 com(축약)을 입력하고 Tab 키를 눌러 특정 주석 블록을 생성할 수 있습니다.

 

  • 설정(Settings/Preferences) 열기: (위와 동일)
  • 라이브 템플릿 위치로 이동: Editor > Live Templates 로 이동합니다.
  • 새 템플릿 그룹 생성 (선택 사항): 오른쪽 + 버튼을 눌러 Template Group을 선택하고 "MyComments"와 같이 그룹을 만들면 관리가 편합니다.
  • 새 라이브 템플릿 생성:
    • 방금 만든 그룹(또는 Java 그룹)을 선택한 상태에서 + 버튼을 누르고 Live Template을 선택합니다.
  • 템플릿 내용 채우기: 하단에 템플릿 세부 정보를 입력합니다.
    • Abbreviation (축약어): com (원하는 단축키를 입력하세요)
    • Description (설명): 메서드 설명 주석 (이 템플릿이 무엇인지 설명하는 간단한 메모입니다)
    • Template text (템플릿 텍스트): 
/**
 * @description $DESC$
 * @param       $PARAM$
 * @return      $RETURN$
 * @since       $DATE$
 */
$END$

 

 

  • 변수 설정 (Edit variables):
    • Template text 아래에 No applicable contexts... 라는 경고가 보일 겁니다. Define을 클릭하고 Java > Comment (또는 Declaration, Everywhere 등)를 선택해 이 템플릿이 작동할 범위를 지정해 주세요.
    • Edit variables 버튼을 클릭합니다.
    • DESC, PARAM, RETURN 변수가 보일 겁니다. 이 변수들의 Expression(표현식)은 비워두고, Default value(기본값)에 따옴표와 함께 " " (빈 문자열)를 넣어주면 좋습니다. Skip if defined를 체크하면 템플릿 사용 시 해당 위치로 커서가 순서대로 이동합니다.
    • DATE 변수 설정 : 변수 목록에 DATE가 보일 겁니다.
      • DATE 변수 행을 찾습니다.
      • Expression (표현식) 컬럼의 빈칸을 클릭하고 date() 라고 입력합니다.
      • 'Skip if defined' (정의된 경우 건너뛰기) 체크박스를 반드시 체크합니다. (이걸 체크해야 템플릿이 날짜를 자동으로 채우고 커서가 멈추지 않습니다.)
      파일 헤더와 형식을 맞추고 싶다면 Expression 란에 date("yyyy.MM.dd") 라고 입력하는 것을 추천합니다.
      • date(): 기본 형식 (예: 11/2/25)
      • date("yyyy.MM.dd"): 2025.11.02 형식
      • date("yyyy-MM-dd"): 2025-11-02 형식
    • OK를 눌러 저장합니다.
  • 적용 및 확인:
    • Apply > OK를 눌러 설정을 저장합니다.
    • Java 파일의 메서드 바로 위 줄에서 com을 입력한 뒤 Tab 키를 눌러보세요. 템플릿이 삽입됩니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

728x90
저작자표시 (새창열림)