java里注釋
『壹』 java中的注釋可分為三種類型
Java中三種類型的注釋：
單行注釋：// 注釋內容
多行注釋：/*... 注釋內容....*/
文本注釋：/**.. 注釋內容....*/
代碼注釋是架起程序設計者與程序閱讀者之間的通信橋梁，最大限度的提高團隊開發合作效率。也是程序代碼可維護性的重要環節之一。所以不是為寫注釋而寫注釋。
備註：簡單的代碼做簡單注釋，注釋內容不大於10個字即可，另外，持久化對象或VO對象的getter、setter方法不需加註釋。
(1)java里注釋擴展閱讀：
類（模塊）注釋採用 /** …… */，在每個類（模塊）的頭部要有必要的注釋信息，包括：工程名；類（模塊）編號；命名空間；類可以運行的JDK版本；版本號；作者；創建時間；類（模塊）功能描述（如功能、主要演算法、內部各部分之間的關系、該類與其類的關系等，必要時還要有一些如特別的軟硬體要求等說明）；主要函數或過程清單及本類（模塊）歷史修改記錄等。
『貳』 java注釋里的這些標記分別是什麼意思
方法/步驟
java注釋，總共有3種注釋方法。
注意事項
注釋內容是不被編輯的內容，只是解釋說明
注釋，為了更方便的閱讀
每次單行注釋、多行注釋，要選中要注釋的內容
『叄』 java 中的幾種注釋方式
我看動力節點的java基礎大全301集教中的三種注釋方法：
1、單行注釋 //注釋的內容
2、多行注釋/*......*/
3、/**......*/，這種方式和第二種方式相似。這種格式是為了便於javadoc程序自動生成文檔。
下面介紹一下Javadoc的標記：
特別聲明：
（1）javadoc針對public類生成注釋文檔
（2）javadoc只能在public、protected修飾的方法或者屬性之上
（3）javadoc注釋的格式化：前導*號和HTML標簽
（4）javadoc注釋要僅靠在類、屬性、方法之前
下面主要舉例說明第三種注釋的應用：
（1）首先編寫.java文件
（2）在命令行中執行以下dos命令：
javadoc *.java //根據相應的Java源代碼及其說明語句生成HTML文檔
//javadoc標記：是@開頭的，對javadoc而言，特殊的標記。
（3）在當前目錄下就會產生doc文件夾，裡面有一系列的.html文件
附上代碼：
[java]view plain
<spanstyle="font-size:18px;">*/
/**javadoc注釋的內容
*/
publicclassHello{
/**屬性上的注釋*/
publicStringname;
/**這是main方法,是程序的入口
*@paramargs用戶輸入參數
*/
publicstaticvoidmain(String[]args){
System.out.println("HelloWorld!");
f1();
}
/**這是第1個方法,其作用是...*/
publicstaticvoidf1(){
System.out.println("f1()！");
}
}</span>
<spanstyle="font-size:18px;">importjava.io.IOException;
/**javadoc注釋內容
*@since1.0
*@version1.1
*@authorBlueJey
*<br>鏈接到另一個文檔{@linkHello},就這些
*seeHello
*/
publicclassHelloWorld{
/**非public，protected屬性上的注釋不生成*/
publicStringname;
/**這是main方法，是程序的入口
*@paramargs用戶輸入的參數，是數組
*@throwsIOExceptionmain方法io異常
*/
publicstaticvoidmain(Stringargs[])throwsIOException{
System.out.println("helloWorld!");
f1();
f2(1);
}
/**這是第一個方法，其作用是....
*@deprecated從版本1.2開始，不再建議使用此方法
*/
publicstaticvoidf1(){
System.out.println("fl()!");
}
/**這是第二個方法，其作用是....
*@return返回是否OK
*@parami輸入參數i
*@seeHello
*@throwsIOExceptionio異常
*/
publicstaticStringf2(inti)throwsIOException{
System.out.println("f1()!");
return"OK";
}
}</span>
[java]view plain
注意：
如果源文件中有用到@version,@author標記，則在執行javadoc命令時，要加-version-author
javadoc-version-author-ddoc*.java
（其中用-version用於提取源文件中的版本信息-author用於提取源文件中的作者信息）
『肆』 Java 語言有哪幾種注釋符
單行注釋：
從「//」開始到行末結束，均視為單行注釋。
多行注釋：
從「/*」開始到「*/」結束，均視為多行注釋。
文檔注釋：
從「/**」開始到「*/」結束，均視為文檔注釋。
文檔注釋與多行注釋的區別：
文檔注釋可以用javadoc命令提取出來，生成類似於jdk文檔的網頁文件，以便於他人了解一個類的功能。
『伍』 如何寫Java文檔注釋
如何寫Java文檔注釋(Java Doc Comments)
本文翻譯自How to Write Doc Comments for the Javadoc Tool，但是精簡了一些私以為不重要的東西
本文不討論如何使用javadoc工具自動生成文檔的方法，而是主要探討應該如何去寫文檔注釋
業余時間整理，難免有遺漏或錯誤，如有發現歡迎指正
轉載地址：網頁鏈接
文檔注釋概覽
「文檔注釋」(Java Doc Comments)是專門為了用javadoc工具自動生成文檔而寫的注釋，它是一種帶有特殊功能的注釋。
文檔注釋與一般注釋的最大區別在於起始符號是/**而不是/*或//。
比如：
/**這是文檔注釋*/
/* 這是一般注釋*/
// 這是一般注釋
在一些IDE（比如Eclipse）中，文檔注釋會以不同於普通注釋的顏色高亮顯示。
此外，文檔注釋只負責描述類(class)、介面(interface)、方法(method)、構造器(constructor)、成員欄位(field)。相應地，文檔注釋必須寫在類、介面、方法、構造器、成員欄位前面，而寫在其他位置，比如函數內部，是無效的文檔注釋。
文檔注釋採用HTML語法規則書寫，支持HTML標記(tag)，同時也有一些額外的輔助標記。需要注意的是，這些標記不是給人看的（通常他們的可讀性也不好），他們的作用是為了javadoc工具更好地生成最終文檔。所以，雖然有些標記寫起來麻煩且看著不直觀，還是要老老實實按規矩寫滴。
原文地址：網頁鏈接