—— 本文參照 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