[Android Studio] Kotlin 파일 및 메서드 공통 주석 구성하기

해당 글에서는 Andriod Studio 툴을 이용하여 Kotlin 언어를 기반으로 .kt 확장자 내에서 파일에 대한 주석 및 메서드에 대한 주석에 대해 자동화를 구성하기 위한 목적으로 작성한 글입니다.

 

 

1) Androiod Studio Kotlin 파일 설명 템플릿 작성하기

---

1. Android Studio - Preferences … 를 선택합니다

---

 

 

2. Editor - Live Templates - AndriodCommentsKotlin - ‘Live Template’를 선택합니다.

---

 

 

3. 주석 명 / 주석 설명 / 템플릿 텍스트를 입력하고 ‘Edit variables’ 버튼을 누릅니다.

---

 

 

4. 템플릿에 변수를 작성한 것에 대해서 매칭 하는 표현식을 선택합니다

---

 

 

5. “Change” 버튼을 눌러서 적용할 범위를 지정합니다

---

 

 

6. 파일의 최상단으로 이동하여서 단축키(ctrl + J)를 눌러서 해당 주석을 불러옵니다

---

 

7. 구성한 주석을 확인하였습니다.

---

 

 

 

2) 메서드 주석

---

1. Plugins - “kdoc-generator” 검색 - “Install“ 클릭합니다.

---

 

 

2. 간단히 구성한 클래스 내에 함수입니다.

---

 

 

 

 

3. 일반 블록 주석을 수행합니다

---

 

 

4. 아래와 같이 파라미터와 return에 관련된 주석이 구성되었습니다.

---

 

 

오늘도 감사합니다😀