文档章节

Eclipse中添加文档注释快捷键

一本正经的胡说八道韩
 一本正经的胡说八道韩
发布于 2017/07/23 19:06
字数 584
阅读 18
收藏 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

共有 人打赏支持
上一篇: 学习java
一本正经的胡说八道韩
粉丝 1
博文 12
码字总数 5536
作品 0
济南
程序员
私信 提问
Android Studio 注释模板

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

____追梦人
2015/05/28
0
0
Eclipse常用快捷键及快捷键功能失效时的解决方案

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

国士
2015/03/30
0
2
动画讲解 Eclipse 常用快捷键

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

鉴客
2014/10/16
2K
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

没有更多内容

加载失败,请刷新页面

加载更多

127.0.0.1 和 0.0.0.0 地址的区别

1. IP地址分类 1.1 IP地址表示 IP地址由两个部分组成,net-id和host-id,即网络号和主机号。 net-id:表示ip地址所在的网络号。 host-id:表示ip地址所在网络中的某个主机号码。 即: IP-a...

华山猛男
35分钟前
10
0
解决Unknown host 'd29vzk4ow07wi7.cloudfront.net'. You may need to adjust the proxy settings in Gradle.

把 总项目 下的 build.gradle 中的 两个 jcenter() 用 maven{ url ‘http://maven.aliyun.com/nexus/content/groups/public/’} 代替。...

lanyu96
41分钟前
3
0
基于redis的分布式锁

redisson提供了基于redis的分布式锁实现方式,本文就尝试了下锁的使用方式。Redisson同时还为分布式锁提供了异步执行的相关方法,第二节执行介绍。 一、可重入锁验证 同一个jvm里面同一线程的...

noob_chr
49分钟前
10
0
CPU性能过剩提升乏力影响未来行业发展吗?

虽然CPU仍然在不断发展,但是它的性能已经不再仅仅受限于单个处理器类型或制造工艺上了。和过去相比,CPU性能提升的步伐明显放缓了,接下来怎么办,成为横亘在整个行业面前的大问题。 自201...

linux-tao
52分钟前
3
0
设计模式“6”大原则!

面向对象设计原则 概述 对于面向对象软件系统的设计而言,在支持可维护性的同时,提高系统的可复用性是一个至关重要的问题,如何同时提高一个软件系统的可维护性和可复用性是面向对象设计需要...

Java干货分享
今天
8
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部