Eclipse中添加文档注释快捷键

本文介绍如何在Eclipse中自定义代码注释模板及快捷键,包括修改现有的模板和导入自定义的XML模板,适用于希望提高开发效率和代码规范性的开发者。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >


快捷键为:ALT + SHIFT +J
想更换为其他的快捷键:
Window-->Preferences-->General-->Keys;找到"add javadoc comment"更改自己喜欢的快捷键。
另外如果觉得注释也不爽时也可以改改,修改的方法有两种:
1.直接在eclipse给的模板下进行修改
2.自己编写一个xml文档导入进去
那就来先说说第一种方法吧:
打开eclipse
Window-->Preferences-->Java-->Code Style --> Code Templates --> Comments --> types --> Edit

第二种方法是:
点击右边的import按钮选择你写好的模板.xml文件
下面是一个注释行模板codetemplates.xml,可以直接导入使用。贴出源码供大家参考一下
 
Xml代码  收藏代码
<?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>  
 
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值