Android Studio 주석/코드 커스텀 양식 자동생성

[목표 : 주석 단축키로 아래의 형식 자동 생성하기](단축키는 기본적으로 Ctrl+J )
/**
 * @author 85chong
 * @since 2020-03-02
 * @comment : 
**/


1. 창띄우기
- file > settings > Editor > Live Templates

2. 메뉴진입
- 설정창을 보면 여러가지 메뉴가 나오는데 (Android , AndoridComments ,  AndroidLog ...) 그 중에 AndoridComments 메뉴의 좌측 화살표를 눌러서, 하위 메뉴를 오픈한다.

3. 셋팅
- 1. 우측에 작은 + 버튼을 클릭하면 "Live Template" / "TemplateGroup.." 메뉴가 나오는데  LiveTemplate 클릭한다.
- 2. 설정창 하단에 보면 뭔가가 뜨는데 , 거기서 Abbreviation : my_custom_annotation(사용 할 주석의 이름) / Description : 설명을 입력해 주면 주석을 생성 할 수 있다.

4. 커스텀
ex) 아래의 주석을 만들예정임
/**
 * @author 85chong
 * @since $date$
 * @comment $text$
**/


5. 설명
- 위의 부분에서는 굳이 @를 사용하지 않아도 되지만, 나중에 Javadoc(코드 자동 문서화: 아직 학습못함;;)을 사용할지도 모르는 이유에서 @를 넣었음.
- /** **/ 전체 주석을 블럭 줘야하므로, 이걸 사용했지만  한줄 주석인 // 를 여러번 사용하여 동일한 효과를 내도 무방함
- $함수명$  => $ 와 $ 사이는 함수를 사용한다는 의미이므로, 이름은 원하는데로 지으면된다.


6. 디테일 설명
   - 1. 위와 같이 입력했으면, 디테일한 설정을 마무리 해줘야함
   - 2. 우측에 Edit variables 버튼을 클릭
   - 3. 새로운 창이 뜬다. 
      * Name 내가 입력한 $ $사이의 이름이 표시된다. 
      * Expression 은 함수를 지정해주는 곳이다. 
      * (Default value 는 아직 사용의 필요성을 못느껴서 패스했음. )
      * Skip if defined 의 체크 표시가 되어있으면 이부분은 Expression 을 사용한다는 걸 나타냄
   - 4. 다른부분은 입력하는 데로 그대로 출력되지만, 날짜같은 부분은 자동으로 입력되게 해야한다.
   - 5. $date$ 는 날짜를 입력하게 함수를 지정해줘야한다. $date$ 라인에 Expression 빈칸을 선택하면, 사용할수있는 함수목록 중에
        date( )를 선택한다.
   - 5-2. Skip if defined 를 체크한다.
   - 6. OK를 눌러 완료한다.
* Skip if defined 를 체크하지 않으면, 해당 Name 은 input box 로 인식하게 된다. 이점 참고

 

!!!설정에서 하단에 보면 "No applicable context. Define " 있는데 여기 Define 을 눌러서 어디에 해당 주석/코드가 쓰일건지에 대한 설정을 해 주어야만 명령창을 띄웠을때, 리스트에 보여지게 된다. 

 

7.  마무리
- 우측하단에 Apply 버튼 > OK 버튼으로 마무리 한다.


8. 사용법
- 위의 주석을 사용할 곳에 입력바를 위치시킨다. 
- Ctrl + J 를 눌러 명령어 창을 띄운다.
- 목록에서 my_custom_annotation 를 선택하면 해당 위치에 셋팅해놓은 내용이 생성된다.

 

 

!! text file은 위의 Define 에서 Other 메뉴로 체크해주면 .text파일에서도 사용이 가능함

 

- 끝 -