設(shè)置注釋模板的入口: Window->Preference->Java->Code Style->Code Template 然后展開(kāi)Comments節(jié)點(diǎn)就是所有需設(shè)置注釋的元素啦。現(xiàn)就每一個(gè)元素逐一介紹:
文件(Files)注釋標(biāo)簽:
01./**
02.* @Title: ${file_name}
03.* @Package ${package_name}
04.* @Description: ${todo}(用一句話描述該文件做什么)
05.* @author A18ccms A18ccms_gmail_com
06.* @date ${date} ${time}
07.* @version V1.0
08.*/
類型(Types)注釋標(biāo)簽(類的注釋):
01./**
02.* @ClassName: ${type_name}
03.* @Description: ${todo}(這里用一句話描述這個(gè)類的作用)
04.* @author A18ccms a18ccms_gmail_com
05.* @date ${date} ${time}
06.*
07.* ${tags}
08.*/
字段(Fields)注釋標(biāo)簽:
01./**
02.* @Fields ${field} : ${todo}(用一句話描述這個(gè)變量表示什么)
03.*/
/**
* @Fields ${field} : ${todo}(用一句話描述這個(gè)變量表示什么)
*/
構(gòu)造函數(shù)標(biāo)簽:
01./**
02.* <p>Title: </p>
03.* <p>Description: </p>
04.* ${tags}
05.*/
方法(Constructor & Methods)標(biāo)簽:
01./**
02.* @Title: ${enclosing_method}
03.* @Description: ${todo}(這里用一句話描述這個(gè)方法的作用)
04.* @param ${tags} 設(shè)定文件
05.* @return ${return_type} 返回類型
06.* @throws
07.*/
覆蓋方法(Overriding Methods)標(biāo)簽:
01./* (非 Javadoc)
02.* <p>Title: ${enclosing_method}</p>
03.* <p>Description: </p>
04.* ${tags}
05.* ${see_to_overridden}
06.*/
代表方法(Delegate Methods)標(biāo)簽:
01./**
02.* ${tags}
03.* ${see_to_target}
04.*/
getter方法標(biāo)簽:
01./**
02.* @return ${bare_field_name}
03.*/
setter方法標(biāo)簽:
01./**
02.* @param ${param} 要設(shè)置的 ${bare_field_name}
03.*/
簡(jiǎn)單模板例子:
01.view plaincopy to clipboardprint?
02.<?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="true" context="fieldcomment_context" deleted="false" description="字段的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**
03.* @Fields ${field} : ${todo}(用一句話描述這個(gè)變量表示什么)
04.*/
05.</template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**
06. * @return ${bare_field_name}
07. */
08. </template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="創(chuàng)建的構(gòu)造函數(shù)的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**
09.* <p>Title:${file_name} </p>
10.* <p>Description: 構(gòu)造函數(shù)</p>
11.* ${tags}
12.*/
13.</template><template autoinsert="true" context="filecomment_context" deleted="false" description="已創(chuàng)建的 Java 文件的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**
14.* @Title: ${file_name}
15.* @Package ${package_name}
16.* @Description: ${todo}(用一句話描述該文件做什么)
17.* @author DAIGUANGJIU
18.* @date ${date} ${time}
19.* @version V1.0
20.*/
21. </template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**
22. * @param ${param} 要設(shè)置的 ${bare_field_name}
23. */</template><template autoinsert="true" context="typecomment_context" deleted="false" description="創(chuàng)建的類型的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/**
24. * @author ${user}
25. *
26. * ${tags}
27. */</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/**
28.* ${tags}
29.* ${see_to_target}
30.*/</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="覆蓋方法的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/** (非 Javadoc)
31.* <p>Title: ${enclosing_method}</p>
32.* <p>Description: </p>
33.* ${tags}
34.* ${see_to_overridden}
35.*/</template><template autoinsert="true" context="methodcomment_context" deleted="false" description="非覆蓋方法的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**
36. * ${tags}
37. */</template></templa
38.<?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="true" context="fieldcomment_context" deleted="false" description="字段的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**
39.* @Fields ${field} : ${todo}(用一句話描述這個(gè)變量表示什么)
40.*/
41.</template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**
42. * @return ${bare_field_name}
43. */
44. </template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="創(chuàng)建的構(gòu)造函數(shù)的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**
45.* <p>Title:${file_name} </p>
46.* <p>Description: 構(gòu)造函數(shù)</p>
47.* ${tags}
48.*/
49.</template><template autoinsert="true" context="filecomment_context" deleted="false" description="已創(chuàng)建的 Java 文件的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**
50.* @Title: ${file_name}
51.* @Package ${package_name}
52.* @Description: ${todo}(用一句話描述該文件做什么)
53.* @author DAIGUANGJIU
54.* @date ${date} ${time}
55.* @version V1.0
56.*/
57. </template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**
58. * @param ${param} 要設(shè)置的 ${bare_field_name}
59. */</template><template autoinsert="true" context="typecomment_context" deleted="false" description="創(chuàng)建的類型的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/**
60. * @author ${user}
61. *
62. * ${tags}
63. */</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/**
64.* ${tags}
65.* ${see_to_target}
66.*/</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="覆蓋方法的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/** (非 Javadoc)
67.* <p>Title: ${enclosing_method}</p>
68.* <p>Description: </p>
69.* ${tags}
70.* ${see_to_overridden}
71.*/</template><template autoinsert="true" context="methodcomment_context" deleted="false" description="非覆蓋方法的注釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**
72. * ${tags}
73. */</template></templa
Eclipse中Java開(kāi)發(fā)中版權(quán)聲明及編碼風(fēng)格的注釋
Java項(xiàng)目開(kāi)發(fā)中,常常需要在編碼文件上面加上一些版權(quán)聲明或者類注釋,如果文件很多,手工去添加或者修改,會(huì)很麻煩。可以利用工具滿足我們的要求。
一、版權(quán)聲明
可以使用Jautodoc.將jautodoc的plugin和feature目錄對(duì)應(yīng)copy到eclipse目錄中,并且?guī)?clean參數(shù)重新啟動(dòng)一次eclipse(以后不再需要該參數(shù))。到eclipse的window-reference菜單中,java- jautodoc,configure project specific settings中,選擇add file header,并點(diǎn)【edit】按鈕,輸入版權(quán)信息,保存
托福答案 以后要添加版權(quán)時(shí),按alt+shift+J,就可以了。
類似的版權(quán)信息如下:
01./**
02.*@項(xiàng)目名稱: ${project_name}
03.
04.
05.*@文件名稱: ${file_name}
06. *@Date: ${date}
07.*@Copyright: ${year} www.xxx.com Inc. All rights reserved.
08.
09.
10.*注意:本內(nèi)容僅限于xxx公司內(nèi)部傳閱,禁止外泄以及用于其他的商業(yè)目的
11.*/
/**
*@項(xiàng)目名稱: ${project_name}
*@文件名稱: ${file_name}
*@Date: ${date}
*@Copyright: ${year} www.xxx.com Inc. All rights reserved.
*注意:本內(nèi)容僅限于xxx公司內(nèi)部傳閱,禁止外泄以及用于其他的商業(yè)目的
*/
其中${project_name},${file_name}和${date}、${year} 是內(nèi)置的變量,在編輯模板的時(shí)候,輸入$之后,會(huì)有很多類似的變量提示顯示出來(lái)。
二、類注釋,方法注釋等
可以直接使用eclipse的code style功能。
類注釋在window-reference-java-code style-code templates-comments,選中types,然后點(diǎn)擊【edit】按鈕,輸入類注釋信息,保存。
以后要添加版權(quán)時(shí),按Ctrl+alt+J(快捷方式可以在Window-preference-general-keys查看和修改),就可以了。
類似的類注釋如下:
01./**
02.*@Project: ${project_name}
03.*@Author: Vin
04.
05.
06.*@Date: ${date}
07.*@Copyright: ${year} www.xxx.com Inc. All rights reserved.
08.*/
同樣,這里的${date}也是預(yù)定義的變量 .
window-preference-java-code style-code templates-comments,選中types,可以編輯類的注釋,
window-preference-java-code style-code templates-comments,選中files,可編輯類文件的注釋
window-preference-java-code style-code templates-comments,選中methods,可編輯方法的注釋
等等。
在window-preference-java-code style-code templates-code,編輯new class files,加入
01.${filecomment}
02.${package_declaration}
03.
04.
05.${typecomment}
06.${type_declaration}
可以在新建一個(gè)類文件的時(shí)候自動(dòng)加入前面設(shè)置的文件注釋和類注釋。
方法注釋的操作與類注釋的操作類似。可以自己研究。
最后,要使用這些注釋,在window-preference-java-code style,將Automatically add comments for new methods and types選上才可應(yīng)用到開(kāi)發(fā)中
托福答案