文档章节

Eclipse中添加文档注释快捷键

一本正经的胡说八道韩
 一本正经的胡说八道韩
发布于 2017/07/23 19:06
字数 584
阅读 14
收藏 0

Eclipse中添加文档注释快捷键

例如:

/**

*/

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

本文转载自:http://jingyan.baidu.com/article/219f4bf7de7489de442d38a5.html

共有 人打赏支持
一本正经的胡说八道韩
粉丝 1
博文 12
码字总数 5536
作品 0
济南
程序员
Eclipse常用快捷键及快捷键功能失效时的解决方案

当Eclipse快捷键功能,或者使用菜单时都无效。例如:搜索引用(快捷键Ctrl+Shift+G)无效; 解决方案:转换WorkSpace,或者删除WorkSpace目录下的.metadata文件夹,重启Eclipse,重新设置。 ...

国士
2015/03/30
0
2
Android Studio 注释模板

1、主题。 File->Settings, 搜索Theme, 点开Appearance, 在右边面板的Theme中选择Darcula。 2、注释快捷键。 File->Settings, 搜索keymap,点开Keymap,在右边面板上搜索,找到Other->Fix ...

____追梦人
2015/05/28
0
0
动画讲解 Eclipse 常用快捷键

Eclipse有强大的编辑功能, 工欲善其事,必先利其器, 掌握Eclipse快捷键,可以大大提高工作效率。小坦克我花了一整天时间, 精选了一些常用的快捷键操作,并且精心录制了动画, 让你一看就会...

鉴客
2014/10/16
1K
25
Eclipse用法:使用Javadoc导出项目的API文档

eclipse直接自动生成整个项目的API帮助文档的小tips 另外,eclipse加入doc注释的快捷键:Shift+Alt+J 本文将具体讲述使用Eclipse开发工具导出项目的Javadoc文档的步骤和常见的问题。 技术文档...

s360564346
2016/04/28
63
0
Eclipse的常用功能

1、eclipse的基础 不要使用中文版 1.1、workspace 所有的开发项目都需要在workspace中,记住workspace放置在一个不会被删除的目录中 改变workspace 1.2、project eclipse和大多数IDE一样,都...

pmos
2016/08/02
68
0

没有更多内容

加载失败,请刷新页面

加载更多

中国发布域名系统基础软件 “红枫”

9月12日消息,域名工程中心(英文缩写 ZDNS)发布了宣称自主开发的域名系统基础软件 “红枫(Maple DNS)”。 9月12日消息,域名工程中心(英文缩写 ZDNS)发布了宣称自主开发的域名系统基础软...

问题终结者
34分钟前
1
0
Shell编程(分发系统介绍、expect远程登录、expect远程执行命令、expect传递参数)

分发系统介绍expect 分发系统expect即分发脚本,是一种脚本语言;通过他可以实现传输,输入命令(上线代码) 应用场景:业务越来越大,网站app,后端,编程语言是php,所以就需要配置lamp或者...

蛋黄_Yolks
39分钟前
1
0
Java Http请求工具类

public static String httpPost(String source, String params) {URL url = null;HttpURLConnection conn = null;OutputStream os = null;String ret = null;try {......

yuewawa
45分钟前
1
0
C++11 智能指针

C++11提供了三个智能指针,std::shared_ptr,std::unique_ptr,std::weak_ptr。最常用的是shared_ptr和unique_ptr。 (1)std::shared_ptr shared_ptr是共享指针,通过在控制块中增加引用计数...

yepanl
46分钟前
1
0
React 服务器渲染原理解析与实践

网盘下载地址 React 服务器渲染原理解析与实践 本套课程,讲解了React中SSR技术的整个搭建思路及流程,完整的从原理上讲清楚了SSR的概念,重点在于讲解编写SSR框架遇到的各种知识点,以及细节...

qq__2304636824
58分钟前
0
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部