Java 程序注釋：

　　1. //：用于單行注釋。Eclipse 下 快捷鍵：Ctrl+/???

　　2. /*...*/:用于多行注釋 快捷鍵：Ctrl+Shift+/??? 關(guān)閉：Ctrl+Shift+\

????? 3./**...*/: doc 注釋。主要是為了支持JDK工具Javadoc而采用的。Javadoc能識(shí)別注釋中用標(biāo)記"@"標(biāo)識(shí)的一些特殊變量，并把doc注釋加入它所生成的html文件。

　　Eclipse添加注釋簡(jiǎn)介：

　　window--preferences--java--Code Templates

　　（1）在方法或者屬性上面添加注釋：
　　在方法或者屬性字段的上面一行輸/**，然后回車(chē)。一般情況下添加的注釋格式如下所示，當(dāng)然注釋的格式是可以修改的：

　　（2）在文件頭添加注釋：
　　用快捷鍵Alt＋Shift+J可以為文件頭快速添加注釋。

　　3）修改注釋的格式：
　　添加的注釋格式是可以修改的，通過(guò)菜單Window->Preference打開(kāi)參數(shù)設(shè)置面板，然后選擇：Java -> Code Style -> Code Templates，在右側(cè)選擇Comments就可以修改注釋的格式。如下圖所示：

????

　　（4）添加注釋的種類(lèi)：
　　從上圖可以看到添加注釋的有Files（文件）注釋，Types（類(lèi)）注釋，Fields（屬性）注釋等。
　　（5）導(dǎo)出和導(dǎo)入注釋：
　　通過(guò)導(dǎo)出和導(dǎo)入功能，可以把自己的模板導(dǎo)出來(lái)在其他機(jī)器上使用
　　（6）注釋變量的設(shè)置
　　我們?cè)趯?xiě)代碼注釋時(shí)經(jīng)常會(huì)出現(xiàn)author，這個(gè)author默認(rèn)的$(user)名也是Administrator。
如果要修改這個(gè)名的話，可以這樣做，打開(kāi)eclipse安裝目錄下的eclipse.ini文件，在文件的末尾添加：
-Duser.name=your name

?? 下面就各comment進(jìn)行簡(jiǎn)單的配置

　1.文件(Files)注釋標(biāo)簽：　

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.類(lèi)型(Types)注釋標(biāo)簽（類(lèi)的注釋）：

/** * @ClassName: ${type_name} * @Description: ${todo}(這里用一句話描述這個(gè)類(lèi)的作用) * @author ${user} * @date ${date} * * ${tags} */ View Code

? 3.字段(Fields)注釋標(biāo)簽：

/** * @Fields ${field} : ${todo}(用一句話描述這個(gè)變量表示什么) */ View Code

? 4.構(gòu)造函數(shù)(Constructor)標(biāo)簽：

/** * 創(chuàng)建一個(gè)新的實(shí)例 ${enclosing_type}. * * ${tags} */ View Code

? 5.方法(Methods)標(biāo)簽：

/** * @Title: ${enclosing_method} * @Description: ${todo}(這里用一句話描述這個(gè)方法的作用) * @param ${tags} 參數(shù) * @return ${return_type} 返回類(lèi)型 * @throws */ View Code

? 6.覆蓋方法(Overriding Methods)標(biāo)簽：

/* (非 Javadoc) * <p>Title: ${enclosing_method}</p> * <p>Description: </p> * ${tags} * ${see_to_overridden} */ View Code

?7.代理方法(Delegate Methods)標(biāo)簽：

/** * ${tags} * ${see_to_target} */ View Code

?8.getter方法標(biāo)簽：

/** * @return ${bare_field_name} */ View Code

?9.setter方法標(biāo)簽：

/** * @param ${param} the ${bare_field_name} to set */ View Code

?可導(dǎo)入配置

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}(這里用一句話描述這個(gè)類(lèi)的作用) 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}(用一句話描述這個(gè)變量表示什么) 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 * 創(chuàng)建一個(gè)新的實(shí)例 ${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}(這里用一句話描述這個(gè)方法的作用) 74 * @param ${tags} 參數(shù) 75 * @return ${return_type} 返回類(lèi)型 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

?

轉(zhuǎn)載于:https://www.cnblogs.com/zuiaiyezi/p/5729362.html

總結(jié)

以上是生活随笔為你收集整理的JAVA 基础 （一）的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。