주석이쁘게 달기

주석 이쁘게 달기 

여기서 '주석 이쁘기 달기'의 의미는 JavaDoc을 만들기 위해 다는 주석입니다. 즉, 메서드, 클래스에 설명을 달 때 쓰는 주석입니다. ㅎㅎ 

1. 주석 다는 방법

1) 간단하게 메서드나 컨트롤러 바로 윗줄에서 

/** 를 친 다음 enter를 누르면 자동으로 생깁니다. 근데 이렇게 만들면 Code Template에서 만든 주석에 enter가 들어가 보기 싫어서 두 번째 방법을 저는 주로 씁니다.

2) 내가 주석을 달고 싶은 메서드,클래스의 맨 앞 혹은 안에 커서를 가져다가 놓고 ALT + SHIFT + J  누르면 생깁니다. 

2. 주석 Template 만들기 

[Window] - [Preferences] - [Java] - [Code Style] - [Code Template]

1. Configure Project Specific Settings...  를 누르면, 프로젝트마다 주석 Template을 설정할 수 있습니다. 

2. 저기 부분이 Code Template를 작성할 수 있는 부분이구요! 

3. Automatically add comments for new methods and types를 체크하게 되면, 파일을 생성할때나 메서드를 만들때 자동으로 주석이 들어가게 됩니다. 

주석 Template를 이용해서 주석을 달 수 있는 곳은 아래와 같습니다. 

수정하기 위해서는 옆에 Edit 버튼을 누르면 됩니다. 

저는 method에 아래와 같은 주석을 달았습니다. 

Edit버튼을 누르고 수정 화면에 들어가, [Insert Variable...]과, 원하는 문구를 이용하여 주석을 작성해주면 됩니다. 

http://help.eclipse.org/neon/index.jsp?nav=%2F0

Edit 화면에 쓸 수 있는 Template Variables에는 

Variable	Description
${cursor}
${date}  ${id:date(format[, locale])}
${dollar}
${enclosing_method}
${enclosing_method_arguments}
${enclosing_package}
${enclosing_project}
${enclosing_type}
${file}
${id:line_selection[(default)]}
${primary_type_name}
${return_type}
${time}
${user}
${id:word_selection[(default)]}
${year}