Java中三種類型的注釋：
創(chuàng)新互聯專注于馬鞍山網站建設服務及定制，我們擁有豐富的企業(yè)做網站經驗。 熱誠為您提供馬鞍山營銷型網站建設，馬鞍山網站制作、馬鞍山網頁設計、馬鞍山網站官網定制、微信平臺小程序開發(fā)服務，打造馬鞍山網絡公司原創(chuàng)品牌,更為您提供馬鞍山網站排名全網營銷落地服務。
單行注釋：// 注釋內容
多行注釋：/*... 注釋內容....*/
文本注釋：/**.. 注釋內容....*/
代碼注釋是架起程序設計者與程序閱讀者之間的通信橋梁，最大限度的提高團隊開發(fā)合作效率。也是程序代碼可維護性的重要環(huán)節(jié)之一。所以不是為寫注釋而寫注釋。
備注：簡單的代碼做簡單注釋，注釋內容不大于10個字即可，另外，持久化對象或VO對象的getter、setter方法不需加注釋。
擴展資料：
類（模塊）注釋采用 /** …… */，在每個類（模塊）的頭部要有必要的注釋信息，包括：工程名；類（模塊）編號；命名空間；類可以運行的JDK版本；版本號；作者；創(chuàng)建時間；類（模塊）功能描述（如功能、主要算法、內部各部分之間的關系、該類與其類的關系等，必要時還要有一些如特別的軟硬件要求等說明）；主要函數或過程清單及本類（模塊）歷史修改記錄等。
參考資料來源：百度百科-java注釋
注釋是用來給開發(fā)者或者是軟件后續(xù)的維護者來看的。一般是用來描述這一段代碼或者是程序做了些什么樣的事情。實現了哪些功能，java里面注釋代碼，可以分為行注釋和塊注釋，方法注釋等。
行注釋就是在需要注釋的代碼前加 //
塊注釋則是用 /* 和 */ 把文本段落框起來即可
我看動力節(jié)點的java基礎大全301集教中的三種注釋方法：
1、單行注釋?? //注釋的內容
2、多行注釋??/*......*/
3、/**......*/，這種方式和第二種方式相似。這種格式是為了便于javadoc程序自動生成文檔。
下面介紹一下Javadoc的標記：
特別聲明：
（1）javadoc針對public類生成注釋文檔
（2）javadoc只能在public、protected修飾的方法或者屬性之上
（3）javadoc注釋的格式化：前導*號和HTML標簽
（4）javadoc注釋要僅靠在類、屬性、方法之前
下面主要舉例說明第三種注釋的應用：
（1）首先編寫.java文件
（2）在命令行中執(zhí)行以下dos命令：
javadoc *.java //根據相應的Java源代碼及其說明語句生成HTML文檔
//javadoc標記：是@開頭的，對javadoc而言，特殊的標記。
（3）在當前目錄下就會產生doc文件夾，里面有一系列的.html文件
附上代碼：
[java]?view plain?copy
span?style="font-size:18px;"*/
/**javadoc注釋的內容
*/
public?class?Hello{
/**屬性上的注釋*/
public?String?name;
/**這是main方法,是程序的入口
*@param?args?用戶輸入參數
*/
public?static?void?main(String[]?args){
System.out.println("Hello?World!");
f1();
}
/**?這是第1個方法,其作用是...*/
public?static?void?f1(){
System.out.println("f1()！");
}
}/span
[java]?view plain?copy
span?style="font-size:18px;"import?java.io.IOException;
/**javadoc注釋內容
*@since?1.0
*@version?1.1
*@author?Blue?Jey
*br鏈接到另一個文檔{@link?Hello},就這些
*see?Hello
*/
public?class?HelloWorld{
/**非public，protected?屬性上的注釋不生成*/
public?String?name;
/**這是main方法，是程序的入口
*@param?args?用戶輸入的參數，是數組
*@throws?IOException?main方法io異常
*/
public?static?void?main(String?args[])?throws?IOException{
System.out.println("hello?World!");
f1();
f2(1);
}
/**這是第一個方法，其作用是....
*@deprecated?從版本1.2開始，不再建議使用此方法
*/
public?static?void?f1(){
System.out.println("fl()!");
}
/**這是第二個方法，其作用是....
*@return?返回是否OK
*@param?i?輸入參數i
*@see?Hello
*@throws?IOException?io異常
*/
public?static?String?f2(int?i)throws?IOException{
System.out.println("f1()!");
return?"OK";
}
}?/span
注意：
如果源文件中有用到@version,@author標記，則在執(zhí)行javadoc命令時，要加-version?-author
javadoc?-version?-author?-d?doc?*.java
（其中用-version用于提取源文件中的版本信息?-author用于提取源文件中的作者信息）
寫代碼的時候，有時候，你需要寫一些注釋，把內容相互關聯起來，方便自己或別人看的時候，可以直接找到你關聯的代碼類或者啥的。
這個時候，{@link}與@see，這2個javadoc注解就派上用場了，
不管他具體有什么功能，咱就只管一個，他可以鏈接代碼，讓注釋看的更清楚易懂。方便你我他。
@see 標簽允許用戶引用其他類的文檔。具體使用方式如下：
@see classname
@see fully-qualified-classname
@see fully-qualified-classname#方法名稱
@see fully-qualified-classname#屬性名稱
我在使用的時候，發(fā)現這個只能單獨一行頂頭寫，如果不頂頭寫就不管用了，沒了鏈接的效果。
但是，{@link}這個卻可以隨便放。
具體使用方法和上面那個@see是一樣的。
實際效果，看下面的圖
重慶分公司
重慶分公司
