注釋是對(duì)代碼的解釋和說明,其目的是讓程序員能夠更加快速的理解代碼。它是編寫程序時(shí),寫程序的人給一個(gè)語句、程序段等的解釋或提示,能提高程序代碼的可讀性。我認(rèn)為添加注釋,是為了程序更容易理解與維護(hù),特別是維護(hù),更是對(duì)自己代碼負(fù)責(zé)的一種體現(xiàn)。
注釋在編譯的時(shí)候不會(huì)生成到 class 字節(jié)碼文件當(dāng)中,它只在 java 源文件中保留。
Java 語言的注釋包括三種方式,它們分別是:
第一種:單行注釋,語法格式如下:
// 單行注釋,兩個(gè)正斜杠后面的內(nèi)容被注釋
第二種:多行注釋,語法格式如下:
/*
這里的注釋信息為多行注釋:
第 1 行注釋信息
第 2 行注釋信息
*/
第三種:javadoc 注釋。
注意:對(duì)于 javadoc 注釋來說,這里的注釋會(huì)被 JDK bin 目錄下的 javadoc.exe 命令解析并生成幫助文檔(生成幫助文檔后期做項(xiàng)目的時(shí)候大家會(huì)接觸到的)。
編寫注釋是程序員最基本的素質(zhì),養(yǎng)成編寫注釋的好習(xí)慣,要有編寫注釋的意識(shí)。當(dāng)然,寫注釋也是有技巧的,不是所有位置都寫,不是把寫的代碼原版翻譯過來,老程序員往往在寫注釋的時(shí)候,不多不少,能夠做到恰到好處,幾句話就可以描述清楚程序的核心功能。
通常要在類和接口上寫注釋,這一部分注釋是必須的。在這里,我們需要使用 javadoc 注釋,需要標(biāo)明:創(chuàng)建者,創(chuàng)建時(shí)間,版本,以及該類的作用。在方法中,我們需要對(duì)入?yún)?,出參,以及返回值,均要?biāo)明。對(duì)常量,我們需要使用多行注釋,進(jìn)行標(biāo)明該常量的用途。在關(guān)鍵算法上,添加注釋并且按照順序依次標(biāo)明,寫明白該方法為什么這么做。
記?。鹤⑨尩淖饔貌辉谟诒硎敬a的含義,而在于表示代碼的功能。希望在以后的課程當(dāng)中通過慢慢的培養(yǎng),能夠?qū)懸皇制恋淖⑨?,?dāng)然,目前大家只需要掌握注釋有哪幾種,分別寫到什么符號(hào)里就行了。
接下來我們?yōu)?HelloWorld 程序提供簡單的注釋信息,來練習(xí)一下注釋的編寫:
/**
* 我的第一個(gè) Java 程序問世了
* @author kxf
* @version 1.0
* @since 1.0
*/
public class HelloWorld {
/**
* 這是程序的入口
* @param args 參數(shù)
*/
public static void main(String[] args) {
// 向控制臺(tái)輸出一段話
System.out.println("HelloWorld !");
}
}
通過以上代碼我們可以看到,HelloWorld 類上寫了一個(gè) javadoc 注釋,在 javadoc 注釋中提供了對(duì)這個(gè)類的整體描述信息、作者信息、版本號(hào)信息等。在 main 方法上提供了 javadoc 注釋,對(duì)這個(gè)方法進(jìn)行了說明,對(duì)參數(shù)進(jìn)行了說明等。在輸出信息的那行代碼上提供了單行注釋,說明了這行代碼的作用。
聯(lián)系客服