Eclipse中添加文档注释快捷键

转载 2013年12月05日 14:44:05

例如:

/**
* @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,可以直接导入使用。贴出源码供大家参考一下

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <templates>
  3. <template autoinsert="false"
  4. context="constructorcomment_context"
  5. deleted="false" description="Comment for created constructors"
  6. enabled="true"
  7. id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"
  8. name="constructorcomment">
  9. /**
  10. * 创建一个新的实例 ${enclosing_type}.
  11. *
  12. * ${tags}
  13. */
  14. </template>
  15. <template autoinsert="true"
  16. context="settercomment_context"
  17. deleted="false"
  18. description="Comment for setter method"
  19. enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment"
  20. name="settercomment">
  21. /**
  22. * @param ${param} the ${bare_field_name} to set
  23. */
  24. </template>
  25. <template autoinsert="false"
  26. context="methodcomment_context"
  27. deleted="false"
  28. description="Comment for non-overriding methods"
  29. enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"
  30. name="methodcomment">
  31. /**
  32. * ${enclosing_method}(这里用一句话描述这个方法的作用)
  33. * TODO(这里描述这个方法适用条件 – 可选)
  34. * TODO(这里描述这个方法的执行流程 – 可选)
  35. * TODO(这里描述这个方法的使用方法 – 可选)
  36. * TODO(这里描述这个方法的注意事项 – 可选)
  37. * @param name
  38. * @param @return 设定文件
  39. * @return String DOM对象
  40. * @Exception 异常对象
  41. * @since CodingExample Ver(编码范例查看) 1.1
  42. */
  43. </template>
  44. <template autoinsert="true"
  45. context="delegatecomment_context"
  46. deleted="false"
  47. description="Comment for delegate methods"
  48. enabled="true"
  49. id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"
  50. name="delegatecomment">
  51. /**
  52. * ${tags}
  53. * ${see_to_target}
  54. */
  55. </template>
  56. <template autoinsert="false"
  57. context="filecomment_context"
  58. deleted="false"
  59. description="Comment for created Java files"
  60. enabled="true"
  61. id="org.eclipse.jdt.ui.text.codetemplates.filecomment"
  62. name="filecomment">
  63. /**
  64. * 文件名:${file_name}
  65. *
  66. * 版本信息:
  67. * 日期:${date}
  68. * Copyright 足下 Corporation ${year}
  69. * 版权所有
  70. *
  71. */
  72. </template>
  73. <template autoinsert="false"
  74. context="gettercomment_context"
  75. deleted="false"
  76. description="Comment for getter method"
  77. enabled="true"
  78. id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"
  79. name="gettercomment">
  80. /**
  81. * ${bare_field_name}
  82. *
  83. * @return the ${bare_field_name}
  84. * @since CodingExample Ver(编码范例查看) 1.0
  85. */
  86. </template>
  87. <template autoinsert="true"
  88. context="overridecomment_context"
  89. deleted="false"
  90. description="Comment for overriding methods"
  91. enabled="true"
  92. id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"
  93. name="overridecomment">
  94. /**
  95. * (non-Javadoc)
  96. * ${see_to_overridden}
  97. */
  98. </template>
  99. <template autoinsert="false"
  100. context="fieldcomment_context"
  101. deleted="false"
  102. description="Comment for fields"
  103. enabled="true"
  104. id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"
  105. name="fieldcomment">
  106. /**
  107. * ${field}:${todo}(用一句话描述这个变量表示什么)
  108. *
  109. * @since Ver 1.1
  110. */
  111. </template>
  112. <template autoinsert="false"
  113. context="typecomment_context"
  114. deleted="false"
  115. description="Comment for created types"
  116. enabled="true"
  117. id="org.eclipse.jdt.ui.text.codetemplates.typecomment"
  118. name="typecomment">
  119. /**
  120. *
  121. * 项目名称:${project_name}
  122. * 类名称:${type_name}
  123. * 类描述:
  124. * 创建人:${user}
  125. * 创建时间:${date} ${time}
  126. * 修改人:${user}
  127. * 修改时间:${date} ${time}
  128. * 修改备注:
  129. * @version
  130. *
  131. */</template>
  132. </templates>

参考文章:http://www.javaeye.com/topic/585168

举报

相关文章推荐

java编码规范及注释快捷键

声明:本文内容来自java编程规范,自己加了一点注释的快捷键  3 文件组织(File Organization) 一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过2000行的程...

java eclipse 注释代码快捷键 取消代码注释快捷键

注释掉代码: 把要注释的代码选中,按Ctrl+Shift+/ /* */ 形式的 ctrl+/ //形式的 取消代码注释: 把要注释的代码选中,按Ctrl+Shift+\ /*...

精选:深入理解 Docker 内部原理及网络配置

网络绝对是任何系统的核心,对于容器而言也是如此。Docker 作为目前最火的轻量级容器技术,有很多令人称道的功能,如 Docker 的镜像管理。然而,Docker的网络一直以来都比较薄弱,所以我们有必要深入了解Docker的网络知识,以满足更高的网络需求。

eclipse 中的注释 快捷键

(1)Ctrl+Space  说明:内容助理。提供对方法,变量,参数,javadoc等得提示,  应运在多种场合,总之需要提示的时候可先按此快捷键。  注:避免输入法的切换设置与此设置冲突 ...
  • wjeson
  • wjeson
  • 2013-06-18 11:27
  • 133670

如何在Eclipse中如何自动添加注释和自定义注释风格

背景简介丰富的注释和良好的代码规范,对于代码的阅读性和可维护性起着至关重要的作用。几乎每个公司对这的要求还是比较严格的,往往会形成自己的一套编码规范。但是再实施过程中,如果全靠手动完成,不仅效率低下,...

Eclipse中自动添加注释(作者,时间)

Eclipse中自动添加注释

Eclipse中关于添加注释的各种方法

2012年01月09日 ⁄ Android, Linux开发 ⁄ 暂无评论 热度: (1)多行注释 Ctrl+/ (2)在方...

eclipse代码注释的设置

1. eclipse用户名的设置: 在eclipse的安装路径下,打开eclipse.ini的配置文件,如下图: 在-vmargs下加入:-Duser.name=你的名字 ...

Eclipse 的快捷键以及文档注释、多行注释的快捷键

一、多行注释快捷键 1.选中你要加注释的区域,用ctrl+shift+C 或者ctrl+/ 会加上//注释 2.先把你要注释的东西选中,用shit+ctrl+/ 会加上/*    */注释 ...

Eclipce 用法和技巧:自动生成的TODO注释

使用eclipse的快捷键自动生成的代码,经常有这样的注释。                    一眼看上去这个注释和一般的注...

Eclipse 的快捷键以及文档注释、多行注释的快捷键

原文地址:http://my.oschina.net/u/590763/blog/70166 一、多行注释快捷键 1.选中你要加注释的区域,用ctrl+shift+C 或者ctrl+/ 会加上//注...
返回顶部
收藏助手
不良信息举报
您举报文章:深度学习:神经网络中的前向传播和反向传播算法推导
举报原因:
原因补充:

(最多只允许输入30个字)