最近聽到很多做程序員的小伙伴兒吐槽：從別人那兒接手的代碼總是亂糟糟的，完全不知道寫的什么！沒有標(biāo)記，沒有說明，也沒有一行注釋，抓耳撓腮也看不懂！

前程序員辭職留下的代碼，誰也不愿意接手

這個(gè)時(shí)候，就需要萬能的“注釋”大大了！

所謂注釋，便是用自然語言對(duì)源代碼中某些語句或方法進(jìn)行說明。并且，注釋的內(nèi)容不會(huì)被編譯器編譯。你可以在源代碼中添加任何你想要添加的說明，隨便多少都可以，只要你不覺得啰嗦。

那么在Java中該如何書寫注釋呢？有以下三種方法：

一、單行注釋

這是最常用的注釋方式，注釋內(nèi)容從//開始，到該行結(jié)束。

舉例：//定義了類的名稱

二、多行注釋

如果需要注釋的內(nèi)容比較多，一行寫不完，如果在每一行注釋中都使用//。

當(dāng)然這種方法比較繁瑣，看起來頁面也不夠簡(jiǎn)潔。這時(shí)候，就需要用到多行注釋了。

/*

*多行注釋內(nèi)容

*/

值得一提的是，多行注釋還有一種不夠簡(jiǎn)潔的注釋方式，那就是嵌套在代碼語句中。不過，實(shí)際應(yīng)用的人很少。

三、文檔注釋

文檔注釋以/**開始，以*/結(jié)束，寫入 javadoc文檔，生成相應(yīng)的Java源碼的API（應(yīng)用程序編程接口）文檔。

常用的文檔注釋有以下幾種：

注意：

1、多個(gè)作者使用多個(gè)@author標(biāo)簽，javadoc按照輸入時(shí)間顯示；

2、@param str the String 用來存放輸出信息，這里表示輸出的str是個(gè)整型；

3、@return true 執(zhí)行成功，輸出執(zhí)行結(jié)果；

4、@since jdk1.6 表示編譯該文件所需要的JDK環(huán)境為jdk1.6；

（關(guān)于JDK的版本介紹會(huì)在后續(xù)的文章中展開，歡迎持續(xù)關(guān)注哈~）

5、@version 1.0 表示該注釋版本的版本號(hào)是1.0；

6、@throws IOException 方法拋出了文件讀取錯(cuò)誤的異常。

7、@deprecated As of JDK1.1,replaced by 表示JDK1.1這個(gè)版本已經(jīng)過期，取代它的是XX；

為了方便理解，小編自己敲了一段代碼示例，希望能幫助大家理解??！

到這里，Java里面的代碼注釋規(guī)則就講完啦！喜歡的朋友們，歡迎來關(guān)注猿小花呦~~~