2-7：如何在java中使用註釋

 

 

1.什麼是註釋？

• 用以描述某段代碼的做用。

2.註釋的三種類型：

• 單行註釋、多行註釋、文檔註釋。以下圖所示：

 

3.咱們能夠經過 javadoc 命令從文檔註釋中提取內容，生成程序的 API 幫助文檔。

4.打開首頁，查看下生成的 API 文檔：

PS：使用文檔註釋時還能夠使用 javadoc 標記，生成更詳細的文檔信息：

       @author 標明開發該類模塊的做者

       @version 標明該類模塊的版本

       @see 參考轉向，也就是相關主題

       @param 對方法中某參數的說明

       @return 對方法返回值的說明

       @exception 對方法可能拋出的異常進行說明