eclipse自动类方法的注释_eclipse快速生成注释资源-CSDN下载

共1个文件

xml：1个

4星 · 超过85%的资源需积分: 50 123 浏览量 2011-05-30 14:32:24 上传评论收藏 864B RAR 举报

在IT行业中，Eclipse是一款广泛使用的Java集成开发环境（IDE），它提供了丰富的功能来提升开发效率。其中，Eclipse的代码模板（Code Templates）功能是程序员们常用的工具，能够帮助自动生成类、方法以及各种注释，从而节省手动编写的时间。本篇文章将详细探讨如何在Eclipse中设置和使用自动类方法的注释。 Eclipse的代码模板功能允许开发者自定义代码片段，当在编辑器中输入特定的关键词或触发条件时，这些预定义的模板就会被插入到当前光标位置。对于类方法的注释，我们可以创建一个模板，以便每次新建或修改方法时，都能快速生成符合规范的注释结构。 1. **设置代码模板**： - 打开Eclipse，点击菜单栏上的“Window” -> “Preferences”。 - 在弹出的“Preferences”对话框中，展开“Java”目录，然后选择“Code Style” -> “Code Templates”。 - 在右侧的“Code Templates”界面，选择“Comments” -> “Methods”，这里显示了默认的方法注释模板。 - 点击右下角的“Edit...”按钮，进入编辑模式，可以修改现有的注释模板或者创建新的模板。 2. **自定义注释模板**： - 在编辑窗口中，你可以看到一个预定义的注释模板，例如： ``` * ${cursor} */ ``` - 这里的`${cursor}`是占位符，表示光标在生成注释后会停在这里，方便你输入方法描述。 - 可以根据项目或团队的编码规范，自定义注释内容，如添加作者、日期、方法参数等信息。例如： ``` /** * ${date} ${user} * ${selected_resource_name} ${selected_resource_path} * @param ${param_name} ${param_description} * @return ${return_description} * @throws ${exception_description} * ${cursor} */ ``` - 模板中的`${}`占位符可以根据实际需要替换为各种信息，比如`date`和`user`会自动填充当前日期和用户名。 3. **应用和使用模板**： - 完成模板编辑后，点击“OK”保存设置。 - 当你在Eclipse中创建新方法或选中现有方法时，按下`Ctrl + Shift + J`（或`Alt + Shift + J`，视系统快捷键设置而定），就会插入所选模板，此时只需要填充具体信息即可。 4. **导出和导入模板**： - 如果你希望将自定义的模板应用到其他Eclipse环境中，可以利用“codetemplates.xml”文件进行导出和导入。 - 要导出模板，回到“Preferences” -> “Java” -> “Code Style” -> “Code Templates”，点击右上角的“Export to File...”，选择保存路径并保存为“codetemplates.xml”。 - 要导入模板，再次回到“Code Templates”界面，点击右上角的“Import...”，选择刚刚保存的“codetemplates.xml”文件，确认导入即可。通过以上步骤，你可以充分利用Eclipse的代码模板功能，定制符合团队规范的类方法注释，提高代码的可读性和维护性。同时，熟练掌握这一功能也能提升开发效率，让编程变得更加便捷。

资源推荐

资源详情

资源评论

收起资源包目录

codetemplates.rar （1个子文件）

codetemplates.xml 3KB

<?xml version="1.0" encoding="UTF-8"?><templates><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"> /** * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo} * @author * @date ${date} ${time} * */ </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: * @param ${tags}: * @return ${return_type} * @throws * @author wangxin * @date ${date} */ </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="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="true" context="overridecomment_context" deleted="false" description="Comment for overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment"> /** (非 Javadoc) * * * ${tags} * ${see_to_overridden} */ </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} * 类描述： * 创建人：WangXin * 创建时间：${date} ${time} * 修改人：WangXin * 修改时间：${date} ${time} * 修改备注： * @version * */ </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="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></templates>

评论收藏

内容反馈