2023년 8월 17일 목요일

안드로이드 라이브 템플릿 (Live Templates) 주석 사용하기

8월 17, 2023 개발정보 , android 0 Comments

안드로이드 라이브 템플릿 (Live Templates)  주석 사용하기


라이브 템플릿이란?

IntelliJ 기반의 IDE(Android Studio 포함)은 라이브 템플릿(Live Templates)기능이 있습니다. 라이브 템플릿은 단축 키워드를 이용하여 몇몇 상용구 코드(Boilerplate code) 작성에 편의를 제공합니다.




STEP01

안드로이드 스튜디오의 Android Studio- > 환경설정(Settings) -> Editor -> Live Templates 에 가면 템플릿을 보거나 만들 수 있다.


STEP01 안드로이드 스튜디오의 Android Studio- > 환경설정(Settings) -> Editor -> Live Templates 에 가면 템플릿을 보거나 만들 수 있다.



STEP02

오른쪽 + 아이콘을 클릭하여 Templete Group...을 선택합니다.


STEP02 오른쪽 + 아이콘을 클릭하여 Templete Group...을 선택합니다.



STEP03

Create New Group창에 등록할 템플릿의 이름을 입력해주세요.


STEP03 Create New Group창에 등록할 템플릿의 이름을 입력해주세요.



STEP04

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


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



STEP05

템플릿 정보를 입력합니다.


Abbrevication : 주석 이름
Description : 설명
Template text : 주석 템플릿 내용

저의 경우에 일반주석, 클래스 주석, 메소드 주석_파라미터 X, 메소드 주석_파라미터 O 이렇게 4가지로 설정하였습니다. 주석이 이름은 앞에 kk_를 붙여서 kk를 누르면 나올수 있게 설정하였습니다. 이부분은 원하시는 이름으로 설정하세요.



1. 일반주석(kk_comment)

Abbrevication : kk_comment
Descriptikon : 일반주석
Templete text :
/**
 * $Text$
 */
일반주석(kk_comment)




2. 클래스 주석(kk_commentClass)

Abbrevication : kk_commentClass
Descriptikon : 클래스 주석
Templete text :
/**
 * Created by kimin on $date$
 * $Text$
 */

Edit variables click후
date에 Expression에 date("YYYY. M. d..") 적고 Skip if defined 체크
확인
클래스 주석(kk_commentClass)





3. 메소드 주석_파라미터 X (kk_commentMethodParamNO)

Abbrevication : kk_commentMethodParamNO
Descriptikon : 메소드 주석_파라미터 X
Templete text :
/**
 * $Text$
 * @brief   $Text$
 * @return  $returnType$
 * @author  kimin
 */

Edit variables click후
returnType에 Expression에 methodReturnType()적고 Skip if defined 체크
확인
메소드 주석_파라미터 X (kk_commentMethodParamNO)




4. 메소드 주석_파라미터 O (kk_commentMethodParamYES)

Abbrevication : kk_commentMethodParamYES
Descriptikon : 메소드 주석_파라미터 O
Templete text :
/**
 * $Text$
 * @brief   $Text$
 * @param   $parameter$
 * @return  $returnType$
 * @author  kimin
 */

Edit variables click후
returnType에 Expression에 methodReturnType()적고 Skip if defined 체크
parameter에 Expression에 methodParameters()적고 Skip if defined 체크
확인
메소드 주석_파라미터 O (kk_commentMethodParamYES)



5. 각각의 템플릿정보 입력을 완료후 Define or Change버튼을 눌러 자바와 코틀린 파일에 적용할수 있게 체크해주세요.
Java -> Comment, Declaration 체크
Kotlin -> 모두 체크
각각의 템플릿정보 입력을 완료후 Define or Change버튼을 눌러 자바와 코틀린 파일에 적용할수 있게 체크




STEP06

주석 확인


주석 확인 

/**
 * 일반주석
 */

/**
 * Created by kimin on 2023. 10. 16..
 * 클래스 주석
 */

/**
 * 매소드 주석_파라미터 X
 * @brief   매소드 주석_파라미터 X
 * @return  
 * @author  xxx
 */

/**
 * 매소드 주석_파라미터 O
 * @brief   매소드 주석_파라미터 O
 * @param   
 * @return  
 * @author  xxx
 */


By -
라벨: ,