添加Java文档注释
一、在Eclipse中add javadoc comment的快捷键为:
快捷键为:ALT + SHIFT +J
二、Window-->Preferences-->General-->Keys;找到"add javadoc comment"更改自己喜欢的快捷键。
三、另外如果觉得注释也不爽时也可以改改,修改的方法有两种:
1.直接在eclipse给的模板下进行修改
打开eclipse
Window-->Preferences-->Java-->Code Style --> Code Templates --> Comments --> types --> Edit
/**
*
* 项目名称:${project_name}
* 类名称:${type_name}
* 类描述:
* 创建人:${user}
* 创建时间:${date} ${time}
* 修改人:${user}
* 修改时间:${date} ${time}
* 修改备注:
* @version
*
*/
2.自己编写一个xml文档导入进去
点击右边的import按钮选择你写好的模板.xml文件
下面是一个注释行模板codetemplates.xml,可以直接导入使用。
参考代码如下:
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 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 | <?xml version= "1.0" encoding= "UTF-8" ?> <templates> <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= "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> <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}(这里用一句话描述这个方法的作用) * TODO(这里描述这个方法适用条件 – 可选) * TODO(这里描述这个方法的执行流程 – 可选) * TODO(这里描述这个方法的使用方法 – 可选) * TODO(这里描述这个方法的注意事项 – 可选) * @param name * @param @return 设定文件 * @return String DOM对象 * @Exception 异常对象 * @since CodingExample Ver(编码范例查看) 1.1 */ </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= "filecomment_context" deleted= "false" description= "Comment for created Java files" enabled= "true" id= "org.eclipse.jdt.ui.text.codetemplates.filecomment" name= "filecomment" > /** * 文件名:${file_name} * * 版本信息: * 日期:${date} * Copyright 足下 Corporation ${year} * 版权所有 * */ </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" > /** * ${bare_field_name} * * @return the ${bare_field_name} * @since CodingExample Ver(编码范例查看) 1.0 */ </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" > /** * (non-Javadoc) * ${see_to_overridden} */ </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}(用一句话描述这个变量表示什么) * * @since Ver 1.1 */ </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" > /** * * 项目名称:${project_name} * 类名称:${type_name} * 类描述: * 创建人:${user} * 创建时间:${date} ${time} * 修改人:${user} * 修改时间:${date} ${time} * 修改备注: * @version * */ </template> </templates> |
参考文章:http://blog.csdn.net/helloanyone/article/details/6233540
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】凌霞软件回馈社区,博客园 & 1Panel & Halo 联合会员上线
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 现代计算机视觉入门之:什么是图片特征编码
· .NET 9 new features-C#13新的锁类型和语义
· Linux系统下SQL Server数据库镜像配置全流程详解
· 现代计算机视觉入门之:什么是视频
· 你所不知道的 C/C++ 宏知识
· 不到万不得已,千万不要去外包
· C# WebAPI 插件热插拔(持续更新中)
· 会议真的有必要吗?我们产品开发9年了,但从来没开过会
· 【译】我们最喜欢的2024年的 Visual Studio 新功能
· 如何打造一个高并发系统?