如何在Java中使用注釋

在編寫程序時(shí)，經(jīng)常需要添加一些注釋，用以描述某段代碼的作用。

一般來說，對(duì)于一份規(guī)范的程序源代碼而言，注釋應(yīng)該占到源代碼的 1/3 以上。因此，注釋是程序源代碼的重要組成部分，一定要加以重視哦！

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

運(yùn)行結(jié)果：?Hello Imooc!

看：被注釋的代碼塊在程序運(yùn)行時(shí)是不會(huì)被執(zhí)行的~~

我們可以通過?javadoc?命令從文檔注釋中提取內(nèi)容，生成程序的 API 幫助文檔。

打開首頁(yè)，查看下生成的 API 文檔

PS：使用文檔注釋時(shí)還可以使用?javadoc 標(biāo)記，生成更詳細(xì)的文檔信息：

? ? ? ?@author?標(biāo)明開發(fā)該類模塊的作者

? ? ? ?@version?標(biāo)明該類模塊的版本

? ? ? ?@see?參考轉(zhuǎn)向，也就是相關(guān)主題

? ? ? ?@param?對(duì)方法中某參數(shù)的說明

? ? ? ?@return?對(duì)方法返回值的說明

? ? ? ?@exception?對(duì)方法可能拋出的異常進(jìn)行說明

總結(jié)

以上是生活随笔為你收集整理的Java中注释的使用的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。