Java學(xué)習(xí)之注釋

在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ù)補充。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末夯到,一起剝皮案震驚了整個濱河市嚷缭,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌耍贾,老刑警劉巖阅爽,帶你破解...
    沈念sama閱讀 222,681評論 6 517
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異荐开,居然都是意外死亡付翁,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,205評論 3 399
  • 文/潘曉璐 我一進店門晃听,熙熙樓的掌柜王于貴愁眉苦臉地迎上來百侧,“玉大人,你說我怎么就攤上這事能扒∫撇悖” “怎么了?”我有些...
    開封第一講書人閱讀 169,421評論 0 362
  • 文/不壞的土叔 我叫張陵赫粥,是天一觀的道長观话。 經(jīng)常有香客問我,道長越平,這世上最難降的妖魔是什么频蛔? 我笑而不...
    開封第一講書人閱讀 60,114評論 1 300
  • 正文 為了忘掉前任,我火速辦了婚禮秦叛,結(jié)果婚禮上晦溪,老公的妹妹穿的比我還像新娘。我一直安慰自己挣跋,他們只是感情好三圆,可當(dāng)我...
    茶點故事閱讀 69,116評論 6 398
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般舟肉。 火紅的嫁衣襯著肌膚如雪修噪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,713評論 1 312
  • 那天路媚,我揣著相機與錄音黄琼,去河邊找鬼。 笑死整慎,一個胖子當(dāng)著我的面吹牛脏款,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播裤园,決...
    沈念sama閱讀 41,170評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼撤师,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了拧揽?” 一聲冷哼從身側(cè)響起剃盾,我...
    開封第一講書人閱讀 40,116評論 0 277
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎强法,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體湾笛,經(jīng)...
    沈念sama閱讀 46,651評論 1 320
  • 正文 獨居荒郊野嶺守林人離奇死亡饮怯,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,714評論 3 342
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了嚎研。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片蓖墅。...
    茶點故事閱讀 40,865評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖临扮,靈堂內(nèi)的尸體忽然破棺而出论矾,到底是詐尸還是另有隱情,我是刑警寧澤杆勇,帶...
    沈念sama閱讀 36,527評論 5 351
  • 正文 年R本政府宣布贪壳,位于F島的核電站,受9級特大地震影響蚜退,放射性物質(zhì)發(fā)生泄漏闰靴。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 42,211評論 3 336
  • 文/蒙蒙 一钻注、第九天 我趴在偏房一處隱蔽的房頂上張望蚂且。 院中可真熱鬧,春花似錦幅恋、人聲如沸杏死。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,699評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽淑翼。三九已至腐巢,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間窒舟,已是汗流浹背系忙。 一陣腳步聲響...
    開封第一講書人閱讀 33,814評論 1 274
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留惠豺,地道東北人银还。 一個月前我還...
    沈念sama閱讀 49,299評論 3 379
  • 正文 我出身青樓,卻偏偏與公主長得像洁墙,于是被迫代替她去往敵國和親蛹疯。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,870評論 2 361

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理热监,服務(wù)發(fā)現(xiàn)捺弦,斷路器,智...
    卡卡羅2017閱讀 134,716評論 18 139
  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,327評論 25 707
  • “西藏”在我心里一直是“神秘孝扛、吸引列吼、信仰、純凈”的代名詞苦始。從大學(xué)時期就一直向往西藏寞钥,喜歡藏飾,喜歡那些看不懂的符號...
    0呆_呆0閱讀 310評論 0 2
  • 知道你的足跡將越走越遠 我的心 多少有些孤單 給祥子的標題 給了你 希望陌选,你的行程改簽 在我這里 思念變幻著不同的...
    江城妖怪閱讀 185評論 0 4
  • 我似乎在夢里夢見過如此美麗的早晨 空氣中帶有一點點的喜悅 仿佛這種情景讓我回想起過去 那是有多么的希望 那時是多么...
    狂野的青春閱讀 163評論 1 0