第二章 java基礎(單行和多行注釋)

—— 本文參照 Learn Java for Android Development (第三版)

** 注釋**
源碼必須是可文檔化的珠洗,這樣也是為了方便代碼的閱讀溜歪。不管是我們平時編寫代碼的時候或者是修改已經(jīng)編寫完成的代碼都需要添加相應的注釋。如果修改的內(nèi)容影響了程序原有的邏輯那么就需要及時更新注釋文檔许蓖,要保證代碼跟文檔是一致的蝴猪。
java語言使用注釋的方式來完成文檔的編寫。編譯源碼的過程注釋是不會被編譯的膊爪,更不會生成注釋對應的字節(jié)碼自阱。java支持的注釋方式包括:單行注釋、多行注釋以及javadoc米酬。
** 單行注釋 **
單行注釋指的是最多只占用一行的注釋方式沛豌,這種注釋方式通常是以//這符號打頭,直到出現(xiàn)這個符號的這一行的結尾都表示這一行的注釋內(nèi)容赃额。例如:
System.out.println(Math.sqrt(10 * 10 + 20 * 20)); // Output distance from (0, 0) to (10, 20).
根據(jù)注釋我們可以知道這里求的是(0,0)到(10,20)這兩個坐標之間的直線距離加派。使用的是標準庫函數(shù)sqrt(),sqrt()函數(shù)的功能是求一個數(shù)字的平方根跳芳。
**小貼士: **單行注釋通常是短小但是又很有意義的给赞。一般不要用來注釋意義不大的東西春弥,比如什么了一個整形變量,后面也加一個單行注釋,這就沒什么必要了空免。

** 多行注釋 **
多行注釋通常會占用一行或者多行。多行注釋以這個符號一铅,這對符號中間的就是注釋內(nèi)容尊浪,都會被編譯器忽略。例如:

System.out.println(year % 400 == 0 || (year % 4 == 0 && year % 100 != 0));
這個例子假定了一個任意的四位數(shù)year城看,然后定義了一個復雜的表達式來判斷year是不是閏年女气。并將判斷結果打印出來。注釋解釋了這個復雜的判斷條件析命。
多行注釋里面界定符號不能寫錯了主卫,一定是,不能是*/鹃愤。

Page 33

最后編輯于
?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末簇搅,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子软吐,更是在濱河造成了極大的恐慌瘩将,老刑警劉巖,帶你破解...
    沈念sama閱讀 212,884評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異姿现,居然都是意外死亡肠仪,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,755評論 3 385
  • 文/潘曉璐 我一進店門备典,熙熙樓的掌柜王于貴愁眉苦臉地迎上來异旧,“玉大人,你說我怎么就攤上這事提佣∷庇迹” “怎么了?”我有些...
    開封第一講書人閱讀 158,369評論 0 348
  • 文/不壞的土叔 我叫張陵拌屏,是天一觀的道長潮针。 經(jīng)常有香客問我,道長倚喂,這世上最難降的妖魔是什么每篷? 我笑而不...
    開封第一講書人閱讀 56,799評論 1 285
  • 正文 為了忘掉前任,我火速辦了婚禮端圈,結果婚禮上焦读,老公的妹妹穿的比我還像新娘。我一直安慰自己枫笛,他們只是感情好吨灭,可當我...
    茶點故事閱讀 65,910評論 6 386
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著刑巧,像睡著了一般喧兄。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上啊楚,一...
    開封第一講書人閱讀 50,096評論 1 291
  • 那天吠冤,我揣著相機與錄音,去河邊找鬼恭理。 笑死拯辙,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的颜价。 我是一名探鬼主播涯保,決...
    沈念sama閱讀 39,159評論 3 411
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼周伦!你這毒婦竟也來了夕春?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 37,917評論 0 268
  • 序言:老撾萬榮一對情侶失蹤专挪,失蹤者是張志新(化名)和其女友劉穎及志,沒想到半個月后片排,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 44,360評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡速侈,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,673評論 2 327
  • 正文 我和宋清朗相戀三年率寡,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片倚搬。...
    茶點故事閱讀 38,814評論 1 341
  • 序言:一個原本活蹦亂跳的男人離奇死亡冶共,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出潭枣,到底是詐尸還是另有隱情比默,我是刑警寧澤幻捏,帶...
    沈念sama閱讀 34,509評論 4 334
  • 正文 年R本政府宣布盆犁,位于F島的核電站,受9級特大地震影響篡九,放射性物質(zhì)發(fā)生泄漏谐岁。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 40,156評論 3 317
  • 文/蒙蒙 一榛臼、第九天 我趴在偏房一處隱蔽的房頂上張望伊佃。 院中可真熱鬧,春花似錦沛善、人聲如沸航揉。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,882評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽帅涂。三九已至,卻和暖如春尤蛮,著一層夾襖步出監(jiān)牢的瞬間媳友,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,123評論 1 267
  • 我被黑心中介騙來泰國打工产捞, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留醇锚,地道東北人。 一個月前我還...
    沈念sama閱讀 46,641評論 2 362
  • 正文 我出身青樓坯临,卻偏偏與公主長得像焊唬,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子看靠,可洞房花燭夜當晚...
    茶點故事閱讀 43,728評論 2 351

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

  • Spring Cloud為開發(fā)人員提供了快速構建分布式系統(tǒng)中一些常見模式的工具(例如配置管理赶促,服務發(fā)現(xiàn),斷路器衷笋,智...
    卡卡羅2017閱讀 134,638評論 18 139
  • //Clojure入門教程: Clojure – Functional Programming for the J...
    葡萄喃喃囈語閱讀 3,636評論 0 7
  • 1. Java基礎部分 基礎部分的順序:基本語法芳杏,類相關的語法矩屁,內(nèi)部類的語法,繼承相關的語法爵赵,異常的語法吝秕,線程的語...
    子非魚_t_閱讀 31,603評論 18 399
  • 寫給天堂里的父親 臨近中秋,想看看您的時候只能去墓碑前空幻,一一叩首眼角濕潤時烁峭,您一定想伸出手,讓我感受你的溫柔父親秕铛,...
    紅精靈閱讀 333評論 1 3
  • "艸但两,房價又漲了" 小北拿起一瓶啤酒鬓梅,一口氣喝完了。伴隨著勁爆的搖滾樂谨湘,小北跟隨著重金屬樂器的強烈節(jié)奏聲瘋狂的舞動...
    簡心大叔閱讀 440評論 2 6