`
weitao1026
  • 浏览: 1052983 次
  • 性别: Icon_minigender_1
  • 来自: 上海
社区版块
存档分类
最新评论

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的快捷键以及各个注释的快捷键

    下面将详细介绍Eclipse中的快捷键和文档注释设置。 一、Eclipse中的快捷键 Eclipse提供了许多实用的快捷键,帮助开发者快速完成任务。以下是一些常用的快捷键: * 多行注释快捷键:Ctrl + Shift + C或Ctrl + / * ...

    eclipse_中的注释_快捷键

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

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

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

    eclipse文档注释内容修改.rar

    而"eclipse文档注释内容修改.txt"文件可能包含了具体的操作步骤或者示例,用于辅助理解如何在Eclipse中处理文档注释。 总之,掌握在Eclipse中修改文档注释是一项基础但重要的技能,有助于提高代码的可读性和团队...

    eclipse中的一些常用快捷键

    ### Eclipse中的一些常用快捷键详解 #### 一、编辑与代码辅助快捷键 **【ALT+/】** - **功能描述**:此快捷键为用户提供内容的辅助,即当您在编写代码时,若忘记了某个类、方法或者属性的完整名称,只需输入已知的...

    Eclipse 常用快捷键 doc文档 排版清晰

    3. **【Ctrl+/】快速注释快捷键** - 功能说明:为光标所在行或选中多行代码快速添加或移除注释。 - 使用场景:在调试代码时经常需要临时注释某些代码段,这个快捷键可以大大节省时间。 4. **【Ctrl+D】删除当前行...

    Eclipse中的常用快捷键.txt

    ### Eclipse中的常用快捷键知识点详解 #### 一、概述 Eclipse是一款非常强大的开源集成开发环境(IDE),广泛应用于Java程序开发中。为了提高开发效率,掌握Eclipse中的一些常用快捷键是十分必要的。本文将详细介绍...

    Eclipse常用快捷键

    快速添加注释,能为光标所在行或所选定行快速添加注释或取消注释。 4. 【Ctrl+D】 删除当前行,这也是笔者的最爱之一,不用为删除一行而按那么多次的删除键。 5.【Shift+F2】 打开外部Java文档。当遇到不熟悉的类或...

    Eclipse快捷键大全.

    ### Eclipse 快捷键大全详解 #### 一、编辑与操作类快捷键 ...以上是Eclipse IDE中常用的一些快捷键及其功能介绍。掌握这些快捷键能够大大提高开发效率,让编程变得更加流畅。希望这些内容对您有所帮助!

    Eclipse标准快捷键 word文档

    这份文档详细列举了Eclipse的标准快捷键,涵盖了多种操作场景,包括编辑、导航、搜索、源代码管理和重构等方面。 编辑快捷键是提升开发速度的关键。例如,全局查找并替换(Ctrl+F)可以帮助快速定位和修改代码中的...

    Eclipse最全快捷键

    12. **Ctrl+/** - 注释当前行:快速为当前行添加或移除单行注释。 13. **Ctrl+Space** - 代码助手:自动补全代码,提高编码速度。 14. **Ctrl+Shift+E** - 显示当前打开的所有View的管理器:管理并切换视图。 15....

    Eclipse Java 注释模板

    这些模板包含了如作者、创建日期、版权信息等常见元素,当需要为代码添加注释时,只需通过快捷键或者右键菜单选择相应选项,就可以快速生成结构化的注释。例如,对于一个类的注释,可能包括了类的描述、作者、版本...

    Eclipse 断点调试快捷键

    本文将详细介绍Eclipse中的断点调试快捷键及其使用方法,尤其适合初级开发者快速上手。 #### 一、基本调试快捷键 1. **F5**:逐步执行(Step Over)。此快捷键用于单步执行代码,当执行到函数调用时不会进入函数...

    eclipse debug调试的快捷键和常用快捷键

    本文将详细介绍Eclipse中与Debug相关的快捷键以及其他常用的快捷键,帮助开发者提高工作效率。 #### 一、Debug调试相关的快捷键 1. **F5**: 步入(Step Into) - 当前行的代码会执行,如果当前行包含可进入的...

    Eclipse开发C++主要快捷键

    - **用途**:为当前行添加或多行注释,再次使用该快捷键可取消注释。 15. **显示大纲**: - **快捷键**:`Ctrl + O` - **用途**:快速显示当前文件的大纲视图,便于查看文件结构。 16. **显示继承结构**: - *...

    eclipse常用快捷键

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

    Eclipse 快捷键+MyEclipse 快捷键.txt

    与Eclipse中的Ctrl+/类似,可以快速为当前行添加或移除注释。 **12. Alt+Shift+O:标记当前位置** 此快捷键可以标记当前位置,便于之后快速回到此处。 **13. Ctrl+I:格式化活动元素** 此快捷键可以对当前光标所在...

    eclipse快捷键大全

    本文档主要介绍Eclipse软件中的常用快捷键及其功能。Eclipse是一款广泛应用于Java开发领域的开源集成开发环境(IDE),其强大的功能与高度可定制化的特性使得它成为众多开发者的首选工具之一。熟练掌握Eclipse中的...

    Eclipse快捷键大全.pdf

    ### Eclipse 快捷键大全详解 #### 一、概述 Eclipse是一款广泛应用于...通过掌握这些快捷键,开发者可以在Eclipse中更高效地进行编程工作,提高生产力和代码质量。希望本文能够帮助您更好地利用Eclipse的强大功能。

Global site tag (gtag.js) - Google Analytics