eclipse 注释模板设置
设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍:
文件(Files)注释标签:
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句话描述该文件做什么)
* @author A18ccms A18ccms_gmail_com
* @date ${date} ${time}
* @version V1.0
*/
类型(Types)注释标签(类的注释):
/**
* @ClassName: ${type_name}
* @Description: ${todo}(这里用一句话描述这个类的作用)
* @author A18ccms a18ccms_gmail_com
* @date ${date} ${time}
*
* ${tags}
*/
字段(Fields)注释标签:
/**
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/
构造函数标签:
/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/
方法(Constructor & Methods)标签:
/**
* @Title: ${enclosing_method}
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @param ${tags} 设定文件
* @return ${return_type} 返回类型
* @throws
*/
覆盖方法(Overriding Methods)标签:
/* (非 Javadoc)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/
代表方法(Delegate Methods)标签:
/**
* ${tags}
* ${see_to_target}
*/
getter方法标签:
/**
* @return ${bare_field_name}
*/
setter方法标签:
/**
* @param ${param} 要设置的 ${bare_field_name}
*/
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 | <br><br><br><br><?xml version= "1.0" encoding= "UTF-8" ?> <templates> <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" > /** * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo}(用一句话描述该文件做什么) * @author ${user} * @date ${date} * @version V1.0 */ </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} * @Description: ${todo}(这里用一句话描述这个类的作用) * @author ${user} * @date ${date} * * ${tags} */ </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" > /** * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么) */ </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" > /** * 创建一个新的实例 ${enclosing_type}. * * ${tags} */ </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" > /** * @Title: ${enclosing_method} * @Description: ${todo}(这里用一句话描述这个方法的作用) * @param ${tags} 参数 * @return ${return_type} 返回类型 * @throws */ </template> <template autoinsert= "true" context= "overridecomment_context" deleted= "false" description= "Comment for overriding methods" enabled= "true" id= "org.eclipse.jdt.ui.text.codetemplates.overridecomment" name= "overridecomment" > /* (非 Javadoc) * <p>Title: ${enclosing_method}</p> * <p>Description: </p> * ${tags} * ${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= "gettercomment_context" deleted= "false" description= "Comment for getter method" enabled= "true" id= "org.eclipse.jdt.ui.text.codetemplates.gettercomment" name= "gettercomment" > /** * @return ${bare_field_name} */ </template> <template autoinsert= "true" context= "settercomment_context" deleted= "false" description= "Comment for setter method" enabled= "true" id= "org.eclipse.jdt.ui.text.codetemplates.settercomment" name= "settercomment" > /** * @param ${param} the ${bare_field_name} to set */ </template> </templates> |
java新手自学群 626070845
java/springboot/hadoop/JVM 群 4915800
Hadoop/mongodb(搭建/开发/运维)Q群481975850
GOLang Q1群:6848027
GOLang Q2群:450509103
GOLang Q3群:436173132
GOLang Q4群:141984758
GOLang Q5群:215535604
C/C++/QT群 1414577
单片机嵌入式/电子电路入门群群 306312845
MUD/LIB/交流群 391486684
Electron/koa/Nodejs/express 214737701
大前端群vue/js/ts 165150391
操作系统研发群:15375777
汇编/辅助/破解新手群:755783453
大数据 elasticsearch 群 481975850
本文版权归作者和博客园共有,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文连接,否则保留追究法律责任的权利。
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】凌霞软件回馈社区,博客园 & 1Panel & Halo 联合会员上线
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步