Java注釋(Comment)


                   

//單行注釋

/**/多行注釋

單行注釋和多行注釋,注釋了的內容不參與編譯。

編譯以后生成的.class結尾的字節碼文件中不包含注釋掉的信息

多行注釋不可以嵌套使用

還可以用來調試代碼,把不確定哪個地方有沒有寫錯的時候,注釋掉看還報不報錯

 

 

只能提取文檔注釋

javadoc -d 文件夾名稱 -author -version 源文件名稱.java

 

 

/** */文檔注釋(Java特有的),可以使用javadoc工具軟件來生成信息,並輸出到HTML文件中

@author 標識一個類的作者
@deprecated 指名一個過期的類或成員
{@docRoot} 指明當前文檔根目錄的路徑
@exception 標志一個類拋出的異常
{@inheritDoc} 從直接父類繼承的注釋
{@link} 插入一個到另一個主題的鏈接
{@linkplain} 插入一個到另一個主題的鏈接,但是該鏈接顯示純文本字體
@param 說明一個方法的參數
@return 說明返回值類型
@see 指定一個到另一個主題的鏈接
@serial 說明一個序列化屬性
@serialData 說明通過writeObject( ) 和 writeExternal( )方法寫的數據
@serialField 說明一個ObjectStreamField組件
@since 標記當引入一個特定的變化時
@throws 和 @exception標簽一樣.
{@value} 顯示常量的值,該常量必須是static屬性。
@version 指定類的版本

來源於菜鳥教程

在文件頭部添加:

/*
 * <p>項目名稱: ${project_name} </p> 
 * <p>文件名稱: ${file_name} </p> 
 * <p>描述: [類型描述] </p>
 * <p>創建時間: ${date} </p>
 * <p>公司信息: ************公司 *********部</p> 
 * @author <a href="mail to: *******@******.com" rel="nofollow">作者</a>
 * @version v1.0
 * @update [序號][日期YYYY-MM-DD] [更改人姓名][變更描述]
 */

方法:

/**
 * @Title:${enclosing_method}
 * @Description: [功能描述]
 * @Param: ${tags}
 * @Return: ${return_type}
 * @author <a href="mail to: *******@******.com" rel="nofollow">作者</a>
 * @CreateDate: ${date} ${time}</p> 
 * @update: [序號][日期YYYY-MM-DD] [更改人姓名][變更描述]     
 */

getter

/**
 * 獲取  ${bare_field_name}
 */

setter

/**
 * 設置   ${bare_field_name} 
 * (${param})${field}
 */

 

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM