在本文中,您将了解Kotlin注释,以及为什么以及如何使用它们。
在编程中,注释是程序的一部分,旨在供您和您的其他程序员理解代码。Kotlin编译器(Kompiler)完全忽略了它们。
与Java类似,在Kotlin中有两种类型的注释
/* ... */
// ....
这是一条多行注释,可以跨越多行。Kotlin编译器会忽略从 /* 到的 */所有内容。例如,
/* 这是多行注释。 * 问题打印出“Hello,World!” 到标准输出。 */ fun main(args: Array<String>) { println("Hello, World!") }
传统注释也用于记录Kotlin代码(KDoc)并稍有变化。 KDoc注释以/ **开头,以* /结尾。
编译器将忽略从 // 到行尾的所有内容 。例如,
// Kotlin Hello World Program fun main(args: Array<String>) { println("Hello, World!") // 输出 Hello, World! 到屏幕 }
上面的程序包含两个行尾注释:
// Kotlin Hello World Program
和
// 输出 Hello, World! 到屏幕
注释不应该取代用英语解释写得不好的代码的方法。 应该编写结构良好且可读的代码,然后使用注释。
在大多数情况下,使用注释是用来解释“为什么”而不是“如何”,只要遵循这点就可以了。