Java 程序注释:
1. //:用于单行注释。Eclipse 下 快捷键:Ctrl+/
2. /*...*/:用于多行注释 快捷键:Ctrl+Shift+/ 关闭:Ctrl+Shift+\
3./**...*/: doc 注释。主要是为了支持JDK工具Javadoc而采用的。Javadoc能识别注释中用标记"@"标识的一些特殊变量,并把doc注释加入它所生成的html文件。
Eclipse添加注释简介:
window--preferences--java--Code Templates
(1)在方法或者属性上面添加注释:
在方法或者属性字段的上面一行输/**,然后回车。一般情况下添加的注释格式如下所示,当然注释的格式是可以修改的:
(2)在文件头添加注释:
用快捷键Alt+Shift+J可以为文件头快速添加注释。
3)修改注释的格式:
添加的注释格式是可以修改的,通过菜单Window->Preference打开参数设置面板,然后选择:Java -> Code Style -> Code Templates,在右侧选择Comments就可以修改注释的格式。如下图所示:
(4)添加注释的种类:
从上图可以看到添加注释的有Files(文件)注释,Types(类)注释,Fields(属性)注释等。
(5)导出和导入注释:
通过导出和导入功能,可以把自己的模板导出来在其他机器上使用
(6)注释变量的设置
我们在写代码注释时经常会出现author,这个author默认的$(user)名也是Administrator。
如果要修改这个名的话,可以这样做,打开eclipse安装目录下的eclipse.ini文件,在文件的末尾添加:
-Duser.name=your name
下面就各comment进行简单的配置
1.文件(Files)注释标签:
1 /**
2 * @Title: ${file_name}
3 * @Package ${package_name}
4 * @Description: ${todo}(用一句话描述该文件做什么)
5 * @author ${user}
6 * @date ${date}
7 * @version V1.0
8 */
View Code
2.类型(Types)注释标签(类的注释):
/**
* @ClassName: ${type_name}
* @Description: ${todo}(这里用一句话描述这个类的作用)
* @author ${user}
* @date ${date}
*
* ${tags}
*/
View Code
3.字段(Fields)注释标签:
/**
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/
View Code
4.构造函数(Constructor)标签:
/**
* 创建一个新的实例 ${enclosing_type}.
*
* ${tags}
*/
View Code
5.方法(Methods)标签:
/**
* @Title: ${enclosing_method}
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @param ${tags} 参数
* @return ${return_type} 返回类型
* @throws
*/
View Code
6.覆盖方法(Overriding Methods)标签:
/* (非 Javadoc)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/
View Code
7.代理方法(Delegate Methods)标签:
/**
* ${tags}
* ${see_to_target}
*/
View Code
8.getter方法标签:
/**
* @return ${bare_field_name}
*/
View Code
9.setter方法标签:
/**
* @param ${param} the ${bare_field_name} to set
*/
View Code
可导入配置
1 <?xml version="1.0" encoding="UTF-8"?>
2 <templates>
3 <template
4 autoinsert="false"
5 context="filecomment_context"
6 deleted="false"
7 description="Comment for created Java files"
8 enabled="true"
9 id="org.eclipse.jdt.ui.text.codetemplates.filecomment"
10 name="filecomment">
11 /**
12 * @Title: ${file_name}
13 * @Package ${package_name}
14 * @Description: ${todo}(用一句话描述该文件做什么)
15 * @author ${user}
16 * @date ${date}
17 * @version V1.0
18 */
19 </template>
20 <template
21 autoinsert="false"
22 context="typecomment_context"
23 deleted="false"
24 description="Comment for created types"
25 enabled="true"
26 id="org.eclipse.jdt.ui.text.codetemplates.typecomment"
27 name="typecomment">
28 /**
29 * @ClassName: ${type_name}
30 * @Description: ${todo}(这里用一句话描述这个类的作用)
31 * @author ${user}
32 * @date ${date}
33 *
34 * ${tags}
35 */
36 </template>
37 <template
38 autoinsert="false"
39 context="fieldcomment_context"
40 deleted="false"
41 description="Comment for fields"
42 enabled="true"
43 id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"
44 name="fieldcomment">
45 /**
46 * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
47 */
48 </template>
49 <template
50 autoinsert="false"
51 context="constructorcomment_context"
52 deleted="false"
53 description="Comment for created constructors"
54 enabled="true"
55 id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"
56 name="constructorcomment">
57 /**
58 * 创建一个新的实例 ${enclosing_type}.
59 *
60 * ${tags}
61 */
62 </template>
63 <template
64 autoinsert="false"
65 context="methodcomment_context"
66 deleted="false"
67 description="Comment for non-overriding methods"
68 enabled="true"
69 id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"
70 name="methodcomment">
71 /**
72 * @Title: ${enclosing_method}
73 * @Description: ${todo}(这里用一句话描述这个方法的作用)
74 * @param ${tags} 参数
75 * @return ${return_type} 返回类型
76 * @throws
77 */
78 </template>
79 <template
80 autoinsert="true"
81 context="overridecomment_context"
82 deleted="false"
83 description="Comment for overriding methods"
84 enabled="true"
85 id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"
86 name="overridecomment">
87 /* (非 Javadoc)
88 * <p>Title: ${enclosing_method}</p>
89 * <p>Description: </p>
90 * ${tags}
91 * ${see_to_overridden}
92 */
93 </template>
94 <template
95 autoinsert="true"
96 context="delegatecomment_context"
97 deleted="false"
98 description="Comment for delegate methods"
99 enabled="true"
100 id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"
101 name="delegatecomment">
102 /**
103 * ${tags}
104 * ${see_to_target}
105 */
106 </template>
107 <template
108 autoinsert="false"
109 context="gettercomment_context"
110 deleted="false"
111 description="Comment for getter method"
112 enabled="true"
113 id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"
114 name="gettercomment">
115 /**
116 * @return ${bare_field_name}
117 */
118 </template>
119 <template
120 autoinsert="true"
121 context="settercomment_context"
122 deleted="false"
123 description="Comment for setter method"
124 enabled="true"
125 id="org.eclipse.jdt.ui.text.codetemplates.settercomment"
126 name="settercomment">
127 /**
128 * @param ${param} the ${bare_field_name} to set
129 */
130 </template>
131 </templates>
View Code