[Android Studio] Live Template으로 JavaDoc 쉽게 작성하기

코드를 보다보면 위와 같은 형식의 주석을 만난 적이 있을 것이다.

편집창에서 /** 를 입력하면 자동으로 주석의 색이 변하면서 아래와 같이 되는데,

이를 JavaDoc이라고 한다.

Java 소스 파일에서 API 문서의 HTML 페이지를 생성합니다.

JDK가 설치되어있다면 JavaDoc을 사용할 수 있다고 한다.

JavaDoc을 작성하고 해당 클래스에 커서를 갖다대면 위와 같이 주석의 내용을 확인할 수 있다.

주석을 생활화(?)해야하는 개발자에게 아주 중요한 것이 아닐 수 없다.

 

그런데 클래스를 생성할 때 마다 위의 정보를 하나하나 일일이 작성하는 것은 너무 귀찮다.

좀 더 쉽게 할 순 없을까?

그때 필요한 것이 바로 IntelliJ에서 제공하는 Live Template이다.

라이브 템플릿을 사용하여 루프, 조건, 선언 또는 인쇄 문과 같은 일반적인 구문을 코드에 삽입하세요.

 

안드로이드 스튜디오 설정 > Live Template > + 버튼 클릭 > Live Template 선택

 

먼저 작성해둔 cdoc을 통해 알아보자.

직관적으로 구성되어 있기 때문에 별도의 설명은 생략하고

작성 되는 시점에 결정되어야 하는 것들은 $$으로 작성해준다.

그리고 Edit Variables를 선택해 해당하는 함수를 지정해주면 된다.

그리고 아래 버튼을 클릭해 어디서 사용할 지를 지정해주면 된다.

 

이후 클래스를 만들어 해당 키워드를 입력하면 아래와 같이 주석이 만들어지는 것을 확인할 수 있다.

---

References

javadoc