Eclipse 자동 주석에 대해 ...

프로젝트 개발시, 이클립스의 환경셋팅중 하나인 자동 주석은 여러모로 쓸모가 많다.

주석을 달아야 할 부분은 크게 3가지로 나뉜다. (개인적인 생각이다.)

Java, Jsp, Xml

1. Java

java는 class와 method 바깥에 주석이 달리도록 하면 좋다.

Window > Preferences > Java > Code Style > Code Templates > Comment

까지 들어간다.

Comment > Types : Class 상단 Import 파일 하단에 위치 한다.

sample)

/**

 * @Package Name   : ${package_name}

 * @FileName  : ${file_name}

 * @작성일       : ${date} 

 * @작성자       : 이재희

 * @프로그램 설명 : 

 */

Comment > Methods : Class 하위 Method 상단에 위치 한다.

sample)

/**

 * @Method Name  : ${enclosing_method}

 * @작성일     : ${date} 

 * @작성자     : 이재희

 * @param    :

 * @Method 설명 :

 * ${tags}

 */

2. Jsp

Jsp는 Preferences에서 Web 안에 존재 한다.

Window > Preferences > Web > JSP Files > Editor > Templates

까지 들어간다.

Templates > New JSP File (html) 을 Edit 해준다.

* 참고로 위와 같이 설정 시, HTML이나 그냥 File로 jsp를 만들거나 하면 주석이 달리지 않는다.

(JSP File만 주석이 설정 된다)

sample)

<%

/* =================================================================

 * 

 * 작성일 : ${date}

 *  

 * 작성자 : 이재희

 * 

 * 상세설명 : 

 *   

 * =================================================================

 * 수정일         작성자             내용     

 * -----------------------------------------------------------------------

 * 

 * =================================================================

 */ 

%>

3. Xml

Xml은 찾기가 쉽다. Xml 에 있겠지 뭐...

XML > XML Files > Editor > Templates

까지 들어간다.

Templates > xml declaration 에서 Edit 해준다.

xml declaration 의 default 주석은 

<?xml version="1.0" encoding="${encoding}"?>

라고 달려 있는데, 저 주석은 건들지 않고 추가 하고 싶은 주석을

저 XML 하단에 작성하여 Edit 해준다.

sample)

<?xml version="1.0" encoding="${encoding}"?>

<!-- 

 * =================================================================

 * 작성일 : ${date}

 *  

 * 작성자 : 이재희

 * 

 * 상세설명 : 

 *   

 * =================================================================

 * 수정일         작성자             내용     

 * =============================

 * 

 * ================================================================= 

 -->