Kotlin 註解範例(單行註解、多行註解、函式註解)

單行註解

    
// 單行註解
println("Hello World") // 顯示 "Hello World" 字串
    

在 Android Studio 中的快捷鍵是 Ctrl + /

多行註解

    
/* 多行註解*/

/*
多
行
註
解
*/
    

在 Android Studio 中的快捷鍵是 Ctrl + Shift + / ,如果是使用注音輸入法會被轉換為輸入「?」,如果要在不改快捷鍵的情況下輸入需要切換到其他輸入法中,例如「英文(美國)」

函式註解

Kotlin 是基於 Java 的延伸,Java 的函式註解稱為 Javadoc ,而 Kotlin 的則稱之為 KDoc。
    
/**
 * 回傳兩個數字相加的結果。
 *
 * @param a 第一個數字
 * @param b 第二個數字
 * @return 兩個數字相加的結果
 */
fun add(a: Int, b: Int): Int {
    return a + b
}
    

註解就註解,為什麼要寫函式註解?最主要的用途是方便查看,在好用的開發工具中都會有類似下方圖片這樣的視窗可以快速檢視內容,使用函式註解這樣的格式就可以更清楚的閱讀,讓未來的自己或是其他開發者更好的閱讀。

除了上面 @param 這幾個標籤以外,還有其他標籤可以使用:
  • @param name 參數名稱
  • @return 回傳值
  • @constructor 建構子
  • @receiver 擴充函數
  • @property name 屬性
  • @throws class, @exception class 例外、異常
  • @sample identifier 類別、方法範例
  • @see identifier 補充說明、文件連結
  • @author 作者
  • @since 程式碼撰寫時的版本號碼
  • @suppress 在產生文件時排除這個註解


參考資料:
Kotlin docs - Basic syntax #Comments
Kotlin docs - Document Kotlin code: KDoc

留言