在java中有三種書寫注釋的方式:“//...”垢夹、“/.../”、“/*.../”乌庶。(不帶雙引號“”,...代表被注釋的內(nèi)容)
1契耿、“//”
這是一種最常使用的方式安拟,此種注釋只注釋一行,即“//”所在行宵喂,也就是“//”后面的內(nèi)容糠赦。在本行注釋,有這么幾個作用(本人心得肮亍):
1拙泽、方便自己查看:在下次看到代碼后,自己可以更加快速的理解這句代碼和所在代碼塊中的作用裸燎,以及對上下代碼也更容易理解顾瞻,而不用再一句一句的閱讀源代碼,從而節(jié)省很多時間德绿。
2荷荤、方便其他人閱讀:如果沒有在必要的代碼后面加上注釋,別人就要把源代碼的每一句都要閱讀移稳,不利于別人的閱讀和其他程序員繼續(xù)自己未完成的工作蕴纳。
3、還有一點就是个粱,加上一些注釋古毛,顯得比較專業(yè)。(有些題外話了,不過看著確實如此)
如:
System.out.println("Hello World"); //打印字符串“Hello World”
2稻薇、“/.../”
對于一些較長的注釋嫂冻,也可以用”//“,但是這樣就顯得很麻煩塞椎,所以可以使用” /.../ “了桨仿,它用于注釋若干行。比如說案狠,在編寫了很長一段代碼后蹬敲,編譯運行后有很多錯誤出現(xiàn),一查看莺戒,發(fā)現(xiàn)某個代碼塊有問題,這時候急波,你就可以將這段代碼塊注釋掉从铲,運行后發(fā)現(xiàn)問題解決了。這段注釋掉的代碼就可以用” /.../ “來注釋澄暮∶危或者你需要在一段代碼前寫明這段代碼的作用及方法等,也可以用” /.../ “
如:
/*
查找數(shù)組中的元素
折半法:前提是數(shù)組是按大小順序排列好的泣懊,
用查找的值和中間值比較伸辟,大則和下一半中間值比依次,小則和上一半中間值比馍刮,找到則返回信夫。
小值的編號在左移或大值的編號在右移。判斷是否大小值的編號相遇卡啰,若未找到静稻,則不再循環(huán),返回-1
*/
public static int FindArry1(int[] arr,int key)
{
int min,max,mid;
min = 0;
max = arr.length-1;
mid = (min + max)/2;
//循環(huán)匈辱,查找中間值與要查找的值比較
while(key != arr[mid])
{
if (key > arr[mid])
min = mid +1;
else
max = mid - 1;
if (min > max)
return -1;
mid = (min + max)/2;
}
return mid;
}
3振湾、“/*.../”
這種注釋可以用來自動地生成文檔。在JDK中有個javadoc的工具亡脸,可以由源文件生成一個HTML文檔押搪。使用這種方式注釋源文件的內(nèi)容,顯得很專業(yè)浅碾,并且可以隨著源文件的保存而保存起來大州。也就是說,當(dāng)修改源文件時垂谢,也可能對這個源代碼的需求等一些注釋性的文字進行修改摧茴,那么,這時候可以將源代碼和文檔一同保存埂陆,而不用再另外創(chuàng)建一個文檔苛白。
也可以用下面的方式將一些信息注釋在源文件中:
如:
/**
這是一個簡單的小程序:
@版本:1.7
@作者:玉圣
*/
class Demo
{
public static void main(String [] args)
{
System.out.println("Hello World !");
}
}
需要注意的一點事娃豹,在第二種和第三種注釋方式中不能使用嵌套,也就是說购裙,在“/*...*/”和“/**...*/”的被注釋部分不能再添加“ */ ”了懂版,因為加入了之后,注釋的部分就會在此結(jié)束躏率,而后面的那個“ */ ”就是多出來的部分了躯畴,運行后就會報錯:”非法表達式的開始“。
當(dāng)然薇芝,第三種注釋的形式還可以用到更多的地方蓬抄,在以后的深入學(xué)習(xí)中會在繼續(xù)補充。