[eclipse] 주석 커스텀, templates 설정

1. 경로

1. java : Window - Preperence - Java - Code Style - Code Templates
2. jsp : Window - Preperence - Web > JSP Files > Editor > Templates - New JSP File (html5)
3. javascript : Window - Preperence - Javascript - Code Style - Code Templates
4. html : Window - Preperence - Web > HTML Files > Editor > Templates - New JSP File (5)

2. 원하는 주석 선택

java와 javascript만 해당

Comments	설명
Files	파일 정보 주석, 처음 파일 생성시 가장 위에 자동으로 생성되는 주석, *.java 파일 맨 위에 생성
Types	클래스 정보 주석, 클래스 위에 생성
Constructors	생성자 관련 주석, 클래스 생성자에 적용되는 주석
Methods	클래스 메소드(함수)에 적용되는 주석, 메서드에 대한 정보를 담는 주석, 메소드명 바로 위에 생성
Overriding methods	오버라이딩 메소드(함수)에 적용되는 주석
Delegate methods	델리게이트 메소드(함수)에 적용되는 주석
Getters	Getter에 적용되는 주석
Setters	Setter에 적용되는 주석

3. 내용설명

내용	설명
${user}	사용자 이름
${todo}	해야할일 태그 생성
${date}	현재 날짜
${year}	현재 연도
${time}	현재 시간
${file_name}	선택된 파일 이름
${project_name}	선택된 프로젝트 이름
${package_name}	선택된 패키지 이름
${enclosing_type}	선택된 메서드의 타입
${tags}	Generated Javadoc tags(@param, @return...)
${type_name}	현재 타입의 이름

4. 양식

가장 많이 사용하는 파일과 메서드 문서 주석 양식에 대해 간단히 공유 하려고 한다.

1. 파일

/**
 * 프로그램 설명
 * @date        : ${date}
 * @author      : ${user}
 * @version	: 1.0
 */

이 외에도 파일이름 수정 내역을 날짜 수정한 사람 , 수정한 내용 등을 계속 추가해 적을 수 있는 양식으로 만들어도 좋다.

2. 메서드

/**
 * 메서드 설명
 * @Method Name  	: ${enclosing_method}
 * @date   		: ${date}
 * @author   		: ${user}
 * @version     	: 1.0
 * ----------------------------------------
 * ${tags}
 */

java 메서드 주석은 나중에 해당 메서드를 사용할 때 마우스를 메서드 위에 올렸을 때 간단히 메서드에 관한 설명을 볼 수 있다.

5. 주석을 다는 Tip

참고 링크에 2번 주석을 다는 방법을 요약정리 한 글 입니다. 직접 가셔서 보는 것을 추천드려요

1. 종류
   1. 문서 주석 : /** */에 의해 경계가 결정, javadoc 툴을 사용하여 HTML 파일로 추출 가능
   2. 구현 주석 : /**/와 //에 의해 경계가 결정,개별적 구현에 대한 주석이나, 코드와는 상관없는 주석을 쓸 때 사용
2. tip

   1. 좋은 주석을 작성하는 tip

      1. 주석의 표준을 정해야 한다.
      2. 주석은 소스코드보다 먼저다.
      3. public function 위주로 주석을 단다.
      4. 주석같은 소스코드가 좋다.
      5. Prototyping 시에는 주석이 필요없다.
      6. 처음에는 강제화가 필요하다.

   2. 문서 주석의 tip

      • 자바 클래스, 인터페이스, 생성자, 메서드, 필드 등을 설명 할 때 사용
      • /** */로 경계를 결정
      • 클래스, 인터페이스, 멤버 당 하나씩 넣는다.
      • 선언 바로 전에 나와야 한다.
      • 최상위 레벨의 클래스와 인터페이스들은 열여쓰기를 하지 않고 멤버들은 들여쓰기를 한다.
      • 자바는 문서주석을 주석 이후 처음 나오는 선언문과 연결시키므로 메서드, 생성자 정의 블록 내부에 위치하면 안된다.
      • 문서주석에 적절하지 않은 것에 대한 정보를 제공하려면 선언 바로 후에 block 주석이나 single line 주석을 사용한다. 단, _클래스의 구현에 대한 세부사항은 block 주석_을 사용한다.
      1. 클래스
      2. 멤버변수
      3. 멤버함수
      4. 기타

   3. 구현 주석의 tip

      1. block
      2. single line
      3. trailing
      4. end of line

참고
1. 이클립스 주석 (파일정보/ 메소드정보) 자동완성 설정하기
2. [Tip] 주석을 다는 방법
3. 이클립스 Code Templates을 이용한 주석 자동 생성
4. Eclipse 자동 주석 설정