Enrich the content of eclipse annotations and eclipse annotations

Enrich the content of eclipse annotations and eclipse annotations

How to enrich the content of eclipse annotations

Eclipse-> Window-> Preferences-> Code Templates-> Comments (Comments indicates the annotation template)

1. Files (Java file comment)

/** * Project Name:${project_name} * File Name:${file_name} * Package Name:${package_name} * Date:${date}${time} * Copyright (c) ${year}, chenzhou1025@126.com All Rights Reserved. */

2. Types (Java class annotation)

/*** ClassName: $ {type_name} <br/> * Function: $ {todo} add function. <br/> * Reason: $ {todo} add reason (optional ). <br/> * date: $ {date }$ {time} <br/> * @ author $ {user} * @ version $ {enclosing_type }$ {tags} * @ since JDK 1.6 */

3. Fields)

/*** $ {Field }:$ {todo} (describe the variable in one sentence). * @ since JDK 1.6 */

4. Constructors)

/** * Creates a new instance of ${enclosing_type}. * ${tags} */

5. Methods (Java method annotation)

/*** $ {Enclosing_method}: (the function of this method is described in one sentence ). <br/> * $ {todo} (optional ). <br/> * $ {todo} (the execution process of this method is described here-optional ). <br/> * $ {todo} (the usage of this method is described here-optional ). <br/> * $ {todo} (note for this method here-optional ). <br/> * @ author $ {user} * $ {tags} * @ since JDK 1.6 */

6. Overriding methods (rewrite method annotation)

/*** $ {Todo} briefly describes the implementation functions of this method (Optional). * $ {see_to_overridden }*/

7. Delegate methods (proxy method annotation)

/** * ${tags} * ${see_to_target} */

8. Getters (Java Getter method annotation)

/** * ${bare_field_name}. * @return  the ${bare_field_name} * @since   JDK 1.6 */

9. Setters (Java Setters method annotation)

/** * ${param}. * @param   ${param}    the ${bare_field_name} to set * @since   JDK 1.6 */

Eclipse-> Window-> Preferences-> Code Templates-> Code (Code indicates the Code Template)

1. New Java files (create a java File Code Template)

/** * Project Name:${project_name} * File Name:${file_name} * Package Name:${package_name} * Date:${date}${time} * Copyright (c) ${year}, chenzhou1025@126.com All Rights Reserved. **/${filecomment}${package_declaration}/** * ClassName:${type_name} <br/> * Function: ${todo} ADD FUNCTION. <br/> * Reason:     ${todo} ADD REASON. <br/> * Date:     ${date} ${time} <br/> * @author   ${user} * @version   * @since    JDK 1.6 * @see       */${typecomment}${type_declaration}

2. Method body (Method body template)

// ${todo} Auto-generated method stub${body_statement}

3. Constructor body (Constructor template)

${body_statement}// ${todo} Auto-generated constructor stub

4. Getter body (field Getter method Template

return ${field};

5. Setter body (field Setter method template)

${field} = ${param};

6. Catch block body (exception catch code block template)

// ${todo} Auto-generated catch block${exception_var}.printStackTrace();

 

The detailed codetemplates. xml is as follows:

<? Xml version = "1.0" encoding = "UTF-8" standalone = "no"?> <Templates> <template autoinsert = "false" context = "gettercomment_context" deleted = "false" description = "Comment for getter method" enabled = "true" id = "org. eclipse. jdt. ui. text. codetemplates. gettercomment "name =" gettercomment ">/*** $ {bare_field_name }. ** @ return the $ {bare_field_name} * @ since JDK 1.6 */</template> <template autoinsert = "false" context = "settercomment_context" deleted = "false" description =" comment for setter method "enabled =" true "id =" org. eclipse. jdt. ui. text. codetemplates. settercomment "name =" settercomment ">/*** $ {param }. ** @ param $ {param} the $ {bare_field_name} to set * @ since JDK 1.6 */</template> <template autoinsert = "false" context = "constructorcomment_context" deleted = "false" description = "Comment for created constructors" enabled = "true" id = "org. eclipse. jdt. ui. text. codetemplates. constructorcomment "name =" constructorcomment ">/*** Creates a new instance of $ {enclosing_type }. ** $ {tags} */</template> <template autoinsert = "false" context = "filecomment_context" deleted = "false" description = "Comment for created Java files" enabled = "true" id = "org. eclipse. jdt. ui. text. codetemplates. filecomment "name =" filecomment ">/*** Project Name :$ {project_name} * File Name :$ {file_name} * Package Name :$ {package_name} * Date: $ {date }$ {time} * Copyright (c) $ {year}, chenzhou1025@126.com All Rights Reserved. **/</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 ">/*** ClassName: $ {type_name} & lt; br/& gt; * Function: $ {todo} add function. & lt; br/& gt; * Reason: $ {todo} add reason (optional ). & lt; br/& gt; * date :$ {date }$ {time} & lt; br/& gt; ** @ author $ {user} * @ version $ {enclosing_type }$ {tags} * @ since JDK 1.6 */</template> <template autoinsert = "false" context =" fieldcomment_context "deleted =" false "description =" Comment for fields "enabled =" true "id =" org. eclipse. jdt. ui. text. codetemplates. fieldcomment "name =" fieldcomment ">/*** $ {field }:$ {todo} (in one sentence, describe what this variable represents ). * @ since JDK 1.6 */</template> <template autoinsert = "false" context = "methodcomment_context" deleted = "false" description = "Comment for non-overriding methods" enabled = "true" id = "org. eclipse. jdt. ui. text. codetemplates. methodcomment "name =" methodcomment ">/*** $ {enclosing_method}: (The role of this method is described in one sentence ). & lt; br/& gt; * $ {todo} (optional ). & lt; br/& gt; * $ {todo} (the execution process of this method is described here-optional ). & lt; br/& gt; * $ {todo} (the usage of this method is described here-optional ). & lt; br/& gt; * $ {todo} (here the precautions for this method are described-optional ). & lt; br/& gt; ** @ author $ {user} * $ {tags} * @ since JDK 1.6 */</template> <template autoinsert = "false" context = "overridecomment_context" deleted = "false "description =" Comment for overriding methods "enabled =" true "id =" org. eclipse. jdt. ui. text. codetemplates. overridecomment "name =" overridecomment ">/*** $ {todo} describes the implementation functions of this method (optional ). * $ {see_to_overridden} */</template> <template autoinsert = "true" context = "delegatecomment_context" deleted = "false" description = "Comment for delegate methods" enabled = "true "id =" org. eclipse. jdt. ui. text. codetemplates. delegatecomment "name =" delegatecomment ">/*** $ {tags} * $ {see_to_target} */</template> <template autoinsert =" false "context =" newtype_context "deleted = "false" description = "Newly created files" enabled = "true" id = "org. eclipse. jdt. ui. text. codetemplates. newtype "name =" newtype ">/*** Project Name: $ {project_name} * File Name: $ {file_name} * Package Name: $ {package_name} * Date: $ {date }$ {time} * Copyright (c) $ {year}, chenzhou1025@126.com All Rights Reserved. **/$ {filecomment} $ {package_declaration}/*** ClassName: $ {type_name} & lt; br/& gt; * Function: $ {todo} add function. & lt; br/& gt; * Reason: $ {todo} add reason. & lt; br/& gt; * Date :$ {date }$ {time} & lt; br/& gt; * @ author $ {user} * @ version * @ since JDK 1.6 * @ see */$ {typecomment }$ {type_declaration} </template> <template autoinsert = "true" context = "classbody_context" deleted = "false" description = "Code in new class type bodies" enabled = "true" id = "org. eclipse. jdt. ui. text. codetemplates. classbody "name =" classbody "> </template> <template autoinsert =" true "context =" interfacebody_context "deleted =" false "description =" Code in new interface type bodies "enabled = "true" id = "org. eclipse. jdt. ui. text. codetemplates. interfacebody "name =" interfacebody "> </template> <template autoinsert =" true "context =" enumbody_context "deleted =" false "description =" Code in new enum type bodies "enabled = "true" id = "org. eclipse. jdt. ui. text. codetemplates. enumbody "name =" enumbody "> </template> <template autoinsert =" true "context =" annotationbody_context "deleted =" false "description =" Code in new annotation type bodies "enabled = "true" id = "org. eclipse. jdt. ui. text. codetemplates. annotationbody "name =" annotationbody "> </template> <template autoinsert =" true "context =" catchblock_context "deleted =" false "description =" Code in new catch blocks "enabled = "true" id = "org. eclipse. jdt. ui. text. codetemplates. catchblock "name =" catchblock "> // $ {todo} Auto-generated catch block $ {exception_var }. printStackTrace (); </template> <template autoinsert = "false" context = "methodbody_context" deleted = "false" description = "Code in created method stubs" enabled = "true" id = "org. eclipse. jdt. ui. text. codetemplates. methodbody "name =" methodbody "> // $ {todo} Auto-generated method stub $ {body_statement} </template> <template autoinsert =" true "context =" constructorbody_context "deleted = "false" description = "Code in created constructor stubs" enabled = "true" id = "org. eclipse. jdt. ui. text. codetemplates. constructorbody "name =" constructorbody ">$ {body_statement} // $ {todo} Auto-generated constructor stub </template> <template autoinsert =" true "context =" getterbody_context "deleted = "false" description = "Code in created getters" enabled = "true" id = "org. eclipse. jdt. ui. text. codetemplates. getterbody "name =" getterbody "> return $ {field }; </template> <template autoinsert = "true" context = "setterbody_context" deleted = "false" description = "Code in created setters" enabled = "true" id = "org. eclipse. jdt. ui. text. codetemplates. setterbody "name =" setterbody ">$ {field }=$ {param}; </template> </templates>