`

Eclipse:添加文档注释快捷键 修改快捷键及模板

阅读更多
Eclipse增加文档注释快捷键及修改文档注释快捷键
例如:

/**
  * @param 
  * @return

  */

快捷键为: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



/**  
*   
* 项目名称:${project_name}  
* 类名称:${type_name}  
* 类描述:  
* 创建人:${user}  
* 创建时间:${date} ${time}  
* 修改人:${user}  
* 修改时间:${date} ${time}  
* 修改备注:  
* @version   
*   
*/
第二种方法是:

点击右边的import按钮选择你写好的模板.xml文件

下面是一个注释行模板codetemplates.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>  
分享到:
评论

相关推荐

    Eclipse的快捷键以及各个注释的快捷键

    * 修改文档注释格式:可以通过修改模板或导入XML文件来修改文档注释格式。 修改文档注释格式有两种方法: * 方法一:直接在Eclipse中修改模板。打开Eclipse,进入Window --&gt; Preferences --&gt; Java --&gt; Code Style ...

    eclipse_中的注释_快捷键

    ### Eclipse中的注释快捷键详解 #### 一、概述 Eclipse是一款强大的开源集成开发环境(IDE),广泛应用于Java开发领域。为了提高编程效率,掌握Eclipse中的快捷键显得尤为重要。本文将详细介绍与注释相关的快捷键...

    java编码规范及注释快捷键.doc

    - **方法注释快捷键**:IDEs如Eclipse或IntelliJ IDEA提供了注释生成快捷键,如`/**`+回车键,自动插入方法的Javadoc模板,便于快速添加注释。 #### 四、代码组织策略 - **变量排序**:按照访问级别从高到低排序,...

    Eclipse Java 注释模板

    4. **便于维护**:当需要更新版本信息或者修改作者信息时,只需要更改模板,所有使用该模板的注释都会自动更新。 要自定义Eclipse的Java注释模板,可以按照以下步骤操作: 1. 打开Eclipse,进入`Window` -&gt; `...

    eclipse快捷键与模板

    ### Eclipse 快捷键与模板详解 #### 一、引言 在软件开发过程中,工具的熟练使用能够显著提升工作效率。Eclipse作为一款强大的开源Java集成开发环境(IDE),提供了丰富的快捷键和模板功能,帮助开发者高效编写代码...

    eclipse文档注释内容修改.rar

    在提供的压缩包文件中,"应聘java工程师-郭龙纲-17638413758.doc"可能是一份求职简历,与Eclipse文档注释的修改直接关联不大,但可以作为参考,了解Java工程师应该具备的技能和经验。而"eclipse文档注释内容修改.txt...

    Eclipse快捷键.Eclipse快捷键.Eclipse快捷键.

    ### Eclipse 快捷键详解 #### 一、编辑与文件操作 **Ctrl+Shift+G:** 查找文件引用。这个快捷键可以帮助开发者快速找到一个类或者方法在其他地方的引用情况。 **Ctrl+Shift+N:** 快速打开文件。用户可以通过...

    Eclipse快捷键大全.

    ### Eclipse 快捷键大全详解 #### 一、编辑与操作类快捷键 **Ctrl+1**:自动修复代码中的错误或警告。 **Ctrl+D**:删除当前行。 **Ctrl+Alt+Shift+Enter**:在当前行下方创建新行。 **Alt+Down/Up**:移动当前...

    Eclipse Java注释模板.txt

    ### Eclipse Java注释模板知识点详解 #### 一、概述 在进行Java开发的过程中,良好的代码注释习惯不仅能帮助自己快速回顾代码逻辑,还能方便其他开发者理解代码意图,从而提高整个团队的工作效率。Eclipse作为一款...

    eclipse常用快捷键

    **功能描述**:此快捷键用于添加或编辑Java文档注释(`/* */` 或 `/** */`)。 - **应用场景**:当需要为类、方法或变量添加文档说明时非常方便。按下Alt + Shift + J后,再按Enter键即可快速生成文档注释模板。 - *...

    eclipse注释模板.xml + 修改模板方法 + 使用方法

    本文将详细介绍如何利用Eclipse创建、修改注释模板,以及如何在实际编码中有效使用这些模板,旨在提高开发效率和代码规范性。 一、Eclipse注释模板 Eclipse的注释模板允许程序员快速插入预定义的注释结构,例如类...

    My Eclipse快捷键

    ### MyEclipse快捷键详解 #### 一、编辑与导航 **Ctrl+1**:自动修复当前光标下的代码错误或警告。 **Ctrl+D**:删除当前行。 **Ctrl+Alt+Shift+Enter**:在当前行后插入一行新行。 **Alt+Shift+方向键**:移动...

    eclipse myeclipse java 代码 注释 模板

    本主题聚焦于"Eclipse MyEclipse Java 代码注释模板",这是一种强大的工具特性,它允许程序员自定义代码片段和注释模板,以便在编码时快速插入。以下是对这一主题的详细阐述。 1. **Eclipse MyEclipse**: Eclipse...

    Eclipse快捷键大全.txt

    ### Eclipse快捷键大全 本文将基于提供的文件信息“Eclipse快捷键大全.txt”中的内容,对Eclipse中常用的快捷键进行详细的解读与说明。Eclipse是一款非常强大的开源集成开发环境(IDE),支持多种编程语言,如Java...

    eclipse骨灰级快捷键

    这篇文档将深入探讨Eclipse的一些高级快捷键和使用技巧,帮助你成为真正的Eclipse快捷键大师。 1. **代码编辑快捷键**: - `Ctrl+Shift+T`:快速打开类型,可以查找并打开项目中的任何类。 - `Ctrl+Shift+R`:...

    eclipse get set方法自动注释

    本文将详细介绍如何在Eclipse中利用内置特性来自动添加基于属性文档注释的getter和setter方法。 一、Eclipse生成getter和setter方法的基本步骤 1. 首先,确保你已经在Eclipse中创建了一个Java类,并定义了至少一个...

    IDEA模板和快捷键.docx

    1. **设置为Eclipse快捷键**: IDEA允许用户自定义快捷键布局,如果你习惯Eclipse的快捷键,可以在Keymap设置中选择Eclipse配置,这样可以无缝切换到IDEA,保持原有的操作习惯。 2. **修改快捷键**: 在File &gt; ...

    netbeans的快捷键与代码模板

    ### NetBeans 快捷键与代码模板详解 #### 一、NetBeans简介 NetBeans 是一个开源集成开发环境(IDE),支持多种编程语言,包括 Java、C/C++、PHP 和 HTML5 等。它提供了丰富的功能来提高开发效率,如代码编辑、...

    eclipse 注释模板

    注释模板是提高代码规范性和编写文档效率的重要工具,允许开发者预设好常用的注释结构,只需通过快捷键或菜单即可快速插入到代码中。 **Eclipse 注释模板详解** 1. **创建和管理注释模板** 在Eclipse中,你可以...

    Eclipse 超重点快捷键

    此快捷键用于快速打开Eclipse内置的帮助文档,展示所有可用的快捷键列表。这对于新用户快速熟悉环境以及老用户查找特定快捷键都非常有用。 #### 格式化(对齐):Ctrl+Shift+F 该快捷键能够自动调整Java代码的格式...

Global site tag (gtag.js) - Google Analytics