The Eclipse Comment template on the web, here to sort out some of the more commonly used.
How to edit a comment template:window->preference->java->code style->code templates and then expand Comments The node is all the elements that need to be annotated. Each of these elements is now introduced:
1. Document (files) Note tags:
/** * All rights Reserved, designed by www.tydic.com * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo} (describe the file in a word) * @author: xxxxx * @date: ${date} ${time} * @version V1.0 */
2. Type (Types) Comment Label (note for Class):
/** * @ClassName: ${type_name} * @Description: ${todo} (here is a word describing the role of this class) * @author: xxxxx * @ Date: ${date} ${time} * ${tags} */
3. Field Comment Label:
/** * @Fields ${field}: ${todo} (describe what this variable means in a word) */
4. Constructor Tags:
/** * @Title: ${enclosing_type} * @Description: ${todo} (here is a word describing the effect of this method) * @param: ${tags } * @throws * *
5. Method (Methods) Tags:
/** * @Title: ${enclosing_method} * @Description: ${todo} (here is a word describing the function of this method) * @param: ${tags} * @ return: ${return_type} * @throws */
6. Overlay method (overriding Methods) Label:
/** * <p>title: ${enclosing_method}</p> * <p>description: </p> * ${tags} * ${see_to_overridden} */
7. Delegate method (Delegate Methods) Label:
/** * ${tags} * ${see_to_target} */
8.getter Method Label:
/** * @Title: ${enclosing_method} <BR> * @Description: Please write your Description <BR> * @return: ${field_type} <BR> * *
9.setter Method Label:
/** * @Title: ${enclosing_method} <BR> * @Description: Please write your Description <BR> * @return: ${field_type} <BR> * *
Eclipse Java Comment Template setup