이번 주제는 이클립스에서 개발할 경우 사용하는 주석에 대해 템플릿을 설정하는 것입니다.
주석의 경우 템플릿으로 설정해주지 않으면 사용자마다 스타일이 다르기 때문에 통일성이 깨질 수 있습니다.
통일성이 있어야 한번 보더라도 이해가 쉽기 때문에 템플릿을 설정하여 주석을 작성하도록 합니다.
먼저 템플릿을 설정하기 위해 이클립스를 실행합니다. 실행 후 메인메뉴에서 Windows > Preferences를 클릭합니다.
Preferences 창이 오픈되면 Java > Code Style > Code Template을 클릭합니다.
대개 주석을 추가하는 위치는 Class와 Method 이므로 두가지만 설명합니다.
먼저 Class는 Types 를 수정하면 됩니다.
위 수정내용을 보면, 패키지명과 파일명을 작성해주고, 클래스에 대한 설명, 작성자, 날짜 그리고 이력까지 적어줍니다.
Method 도 동일합니다.
pre 부분에 패키지명과 파일명을 지우고 ${enclosing_method}를 추가합니다
템플릿을 수정 후 Apply를 클릭하면 템플릿 내용이 적용됩니다.
그 후 개발중인 클래스를 오픈하여 [Shift + Alt + J] 를 입력하면 주석이 자동 생성됩니다.
이때, 커서는 주석을 생성하려는 주체의 이름에 위치하면 됩니다. 클래스는 클래스명에, 메서드는 메서드명에 위치하면 됩니다.
여기까지 주석템플릿을 설정하여 주석을 자동으로 생성하는 것을 알아보았습니다.
내용을 참고하여 개발하는 데 도움되시기 바랍니다.
댓글