Java中使用注釋

標籤：分享   規範   api   注釋   運行   info   模組   return   使用   

在編寫程式時，經常需要添加一些注釋，用以描述某段代碼的作用。

一般來說，對於一份規範的程式原始碼而言，注釋應該佔到原始碼的 1/3 以上。因此，注釋是程式原始碼的重要組成部分，一定要加以重視哦！

Java 中注釋有三種類型：單行注釋、多行注釋、文檔注釋

運行結果： Hello Imooc!

看：被注釋的代碼塊在程式運行時是不會被執行的~~

我們可以通過 javadoc 命令從文檔注釋中提取內容，產生程式的 API 協助文檔。

開啟首頁，查看下產生的 API 文檔

PS：使用文檔注釋時還可以使用 javadoc 標記，產生更詳細的文檔資訊：

       @author 標明開發該類別模組的作者

       @version 標明該類別模組的版本

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

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

       @return 對方法傳回值的說明

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

 

 

 

摘自：慕課網

Java中使用注釋