Set the entry for the comment template: Window->preference->java->code style->code Template and expand the Comments node is all the elements that need to be annotated. Each of these elements is now introduced:
Files Note Tags:
/**
- @Title: ${file_name}
- @Package ${package_name}
- @Description: ${todo} (describe what the file does in a word)
- @author A18ccms a18ccms_gmail_com
- @date ${date} ${time}
- @version V1.0
*/
Type (Types) Comment Label (note for Class):
/**
- @ClassName: ${type_name}
- @Description: ${todo} (here is a word describing the role of this class)
- @author A18ccms a18ccms_gmail_com
- @date ${date} ${time}
- ${tags}
*/
Field Comment Label:
/**
- @Fields ${field}: ${todo} (describe what this variable means in a sentence)
*/
Constructor Tags:
/**
Title:
Description:
- ${tags}
*/
Methods (Constructor & Methods) Tags:
/**
- @Title: ${enclosing_method}
- @Description: ${todo} (here is a word describing the effect of this method)
- @param ${tags} settings file
- @return ${return_type} return type
- @throws
*/
Override method (overriding Methods) Label:
/* (non-Javadoc)
Delegate method (Delegate Methods) Label:
/**
- ${tags}
- ${see_to_target}
*/
Getter Method Tags:
/**
- @return ${bare_field_name}
*/
Setter Method Tags:
/**
- @param ${param} to set the ${bare_field_name}
*/
Examples of simple templates:
Example 2:
<template autoinsert= "true" context= "Overridecomment_context" deleted= "false" Description= "Comment for overriding methods" enabled= "true" id= "org.eclipse.jdt.ui.text.cod Etemplates.overridecomment "name=" overridecomment ">/* (non-javadoc) * ${see_to_overridden} */</templ Ate> <template autoinsert= "false" context= "Fieldcomment_context" deleted= "false" Description= "Comment for Fields" enabled= "true" id= "Org.eclipse.jdt.ui.text.codetempl Ates.fieldcomment "name=" fieldcomment ">/** * ${field}:${todo} (describe what this variable means in a word) * * @since Ver 1.1 */&L T;/template> <template autoinsert= "false" context= "Typecomment_context" deleted= "False" description= "Comment for created types" enabled= "true" id= "Org.eclipse.jdt.ui. Text.codetemplates.typecOmment "name=" typecomment ">/** * This class describes: * @author: [email protected] * @version: ${date} ${time} */</template>
Eclipse Java Comment Template setup