在本文中,您將了解Kotlin注釋,以及為什么以及如何使用它們。
在編程中,注釋是程序的一部分,旨在供您和您的其他程序員理解代碼。Kotlin編譯器(Kompiler)完全忽略了它們。
與Java類似,在Kotlin中有兩種類型的注釋
/* ... */
// ....
這是一條多行注釋,可以跨越多行。Kotlin編譯器會忽略從 /* 到的 */所有內(nèi)容。例如,
/* 這是多行注釋。 * 問題打印出“Hello,World!” 到標(biāo)準(zhǔn)輸出。 */ fun main(args: Array<String>) { println("Hello, World!") }
傳統(tǒng)注釋也用于記錄Kotlin代碼(KDoc)并稍有變化。 KDoc注釋以/ **開頭,以* /結(jié)尾。
編譯器將忽略從 // 到行尾的所有內(nèi)容 。例如,
// Kotlin Hello World Program fun main(args: Array<String>) { println("Hello, World!") // 輸出 Hello, World! 到屏幕 }
上面的程序包含兩個(gè)行尾注釋:
// Kotlin Hello World Program
和
// 輸出 Hello, World! 到屏幕
注釋不應(yīng)該取代用英語解釋寫得不好的代碼的方法。 應(yīng)該編寫結(jié)構(gòu)良好且可讀的代碼,然后使用注釋。
在大多數(shù)情況下,使用注釋是用來解釋“為什么”而不是“如何”,只要遵循這點(diǎn)就可以了。