Eclipse中添加文档注释快捷键

可以手动添加
可以在生成文件的时候自动添加

点击Wondows-preferences 
左边的appearance查找code template
里面有javadoc注释的脚本

文档注释生成中文doc方法：


1.项目-->右键菜单Export-->Java下Javadoc-->next：
<1>javadoc command:就是要调用的javadoc.exe，不用修改，eclipse会找到的；
<2>use standard doclet:就是要生成到的目录，自定义一个文件夹作为存放目录[不然一大堆]；
<3>默认即可next-->再next-->
<4>【注意注意】此时如果项目采用的是UTF-8编码，Extra Javadoc options下需要输入设定参数：-encoding utf-8 -charset utf-8否则生成的网页中文注释都是乱码。
<5>最后Finish完成。
在工程的doc 目录中，就有Javadoc 文档了
-------------------------------------------
如何规范生成JAVADOC帮助文档
1.文本注释（/** */）也叫归档注释。
归档注释是一种专用注释；当它放在类或类成员声明之前时，javadoc工具可以提取出这些注释并用它们来生成程序的 HTML文档。归档注释通常入在类、接口、方法及字段定义之前。
2.文本注释中的“文档标记”（Doc tags）是一些以“@”开头的命令;
3.javadoc只能为public（公共）和protected（受保护）成员处理注释文档。“private”（私有）和“友好”成员（即没有访问控制符）的注释会被忽略，我们看不到任何输出（也可以用-private标记包括private成员）。


4.类文档标记
类文档可以包括用于版本信息以及作者姓名的标记。


（1）@version
格式如下：
@version 版本信息
其中，“版本信息”代表任何适合作为版本说明的资料。若在javadoc命令行使用了“-version”标记，就会从生成的HTML文档里提取出版本信息。


（2） @author
格式如下：
@author 作者信息
其中，“作者信息”包括您的姓名、电子函件地址或者其他任何适宜的资料。若在javadoc命令行使用了“-author”标记，就会专门从生成的HTML文档里提取出作者信息。
可为一系列作者使用多个这样的标记，但它们必须连续放置。全部作者信息会一起存入最终HTML代码的单独一个段落里。
--------------------------------------
方法文档标记
方法允许使用针对参数、返回值以及异常的文档标记。


（1）@param
格式如下：
@param 参数名 说明
其中，“参数名”是指参数列表内的标识符，而“说明”代表一些可延续到后续行内的说明文字。一旦遇到一个新文档标记，就认为前一个说明结束。可使用任意数量的说明，每个参数一个。


（2）@return
格式如下：
@return 说明
其中，“说明”是指返回值的含义。它可延续到后面的行内。


（3）@exception
有关“违例”（Exception）的详细情况，
@exception 完整类名 说明
“完整类名”明确指定了一个违例类的名字，它是在其他某个地方定义好的。
而“说明”（同样可以延续到下面的行）告诉我们为什么这种特殊类型的违例会在方法调用中出现。


（4） @deprecated该标记的作用是建议用户不必再使用一种特定的功能，因为未来改版时可能摒弃。
若将一个方法标记为@deprecated，则使用该方法时会收到编译器的警告。






       顺便提一下在eclipse下，当鼠标处于类，方法定义行时，按Alt+Shift+J，就可以快速添加文档注释。至于如何导出javadoc文档，eclipse环境下，file > export > javadoc > 这里只要选中你要导出的*.java文件即可，要十分注意的是，通常很多人的classpath环境下，带有 %classpath% 这使javadoc命令无法正确地执行。而提示的出错信息通常是IlleagalArgumentException。

http://wyzuomumu.iteye.com/blog/947640

例如：

/**
  * @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代码  

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

 

参考文章：http://blog.csdn.net/HelloAnyone/archive/2011/03/09/6233540.aspx

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

(2)Ctrl+Shift+Space
说明:变量提示
(3)Ctrl+/
说明:添加/消除//注释,在eclipse2.0中,消除注释为Ctrl+\

(4)Ctrl+Shift+/
说明:添加/* */注释

(5)Ctrl+Shift+\
说明:消除/* */注释

(6)Ctrl+Shift+F
说明:自动格式化代码

(7)Ctrl+1
说明:批量修改源代码中的变量名,此外还可用在catch块上.

(8)Ctril+F6
说明:界面切换

(9)Ctril+Shift+M
说明:查找所需要得包

(10)Ctril+Shift+O
说明:自动引入所需要得包

(11)Ctrl+Alt+S
说明:源代码得快捷菜单。其中的Generate getters and setters 和 Surround with try/catch
block比较常用.建议把它们添加为快捷键.快捷键设置在windows->preferences->Workbench->Keys