在本教程中,您將了解Java注釋,為什么使用它們以及如何正確使用注釋。
在計(jì)算機(jī)編程中,注釋是程序的一部分,Java編譯器完全忽略了注釋。它們主要用于幫助程序員更容易理解代碼。例如,
//聲明并初始化兩個(gè)變量 int a =1; int b = 3; //打印輸出 System.out.println("This is output");
在這里,我們使用了以下注釋:
聲明并初始化兩個(gè)變量
打印輸出
在Java中,有兩種類型的注釋:
單行注釋
多行評論
單行注釋在同一行開始和結(jié)束。要編寫單行注釋,可以使用//符號。例如,
// "Hello, World!" 程序示例 class Main { public static void main(String[] args) { { // 打印輸出 "Hello, World!" System.out.println("Hello, World!"); } }
輸出:
Hello, World!
在這里,我們使用了兩個(gè)單行注釋:
"Hello, World!" 程序示例
打印輸出 "Hello World!"
Java編譯器會(huì)忽略從//行尾到行尾的所有內(nèi)容。因此,它也稱為行尾注釋(單行注釋)。
當(dāng)我們想寫多行注釋時(shí),可以使用多行注釋。要寫多行注釋,我們可以使用/*....*/符號。例如,
/* 這是多行注釋的示例。 * 該程序?qū)⒋蛴 ?nbsp;Hello,World!” 到標(biāo)準(zhǔn)輸出。 */ class HelloWorld { public static void main(String[] args) { { System.out.println("Hello, World!"); } }
輸出:
Hello, World!
在這里,我們使用了多行注釋:
/* 這是多行注釋的示例。 * 該程序?qū)⒋蛴 ?nbsp;Hello,World!” 到標(biāo)準(zhǔn)輸出。 */
這種類型的注釋也稱為傳統(tǒng)注釋。在這種類型的注釋中,Java編譯器將忽略從/*到的所有內(nèi)容*/。
您應(yīng)該始終要知道一件事,即注釋不應(yīng)該成為代替解釋不良代碼的一種方式。您應(yīng)該始終編寫結(jié)構(gòu)合理且能自我解釋的代碼。然后,再考慮使用注釋。
有些人認(rèn)為代碼應(yīng)該是自描述的,注釋應(yīng)該很少使用。但是,以我個(gè)人的觀點(diǎn),使用注釋并沒有錯(cuò)。我們可以使用注釋來解釋復(fù)雜的算法,正則表達(dá)式或需要在不同技術(shù)中選擇一種技術(shù)來解決問題的方案。
注意:在大多數(shù)情況下,請始終使用注釋來解釋“ 為什么 ”而不是“ 如何做 ”。