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 what the file does in a word )@author: Tian Yuan di technology * @date: ${date} ${ TIME} @version V1.0 * @Copyright: ${year} www.tydic.com Inc. All rights reserved. */
2. Type (Types) Comment Label (note for Class):
/** * @ClassName: ${type_name} * @Description: ${todo} (here is a sentence describing the role of this Class)@author : Tian Yuan Dicko * @date: ${date} ${time} * * ${tags} * @Copyright: ${year} www.tydic.com Inc. All rights reserved. * Note: This content is limited to Shenzhen Tian Yuan di ke Information Technology Co., Ltd. internal circulation, prohibit leakage and for other business purposes * *
3. Field Comment Label:
/** * @Fields ${field}: ${todo} (describe what this variable means in a sentence )* /
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 effect 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> */
The rest is the default, ^_^
Eclipse Java Comment Template settings detailed and copyright notice