📜  Kotlin 注释

📅  最后修改于: 2020-10-05 14:48:36             🧑  作者: Mango

在本文中,您将了解Kotlin注释,以及为什么以及如何使用它们。

在编程中,注释是程序的一部分,旨在供您和您的其他程序员理解代码。 Kotlin编译器(Kompiler)完全忽略了它们。

与Java类似,在Kotlin中有两种类型的注释

  • /* ... */
  • // ....

传统注释/ * … * /

这是一条多行注释,可以跨越多行。 Kotlin编译器会忽略从/**/ 。例如,

/* This is a multi-line comment.
 * The problem prints "Hello, World!" to the standard output.
 */
fun main(args: Array) {

   println("Hello, World!")
}

传统注释也用于记录Kotlin代码(KDoc),但有一些改动。 KDoc注释以/**开头,以*/结尾。


行尾注释//

编译器将忽略//到行尾的所有内容。例如,

// Kotlin Hello World Program
fun main(args: Array) {

   println("Hello, World!")      // outputs Hello, World! on the screen
}

上面的程序包含两个行尾注释:

// Kotlin Hello World Program

// outputs Hello, World! on the screen

正确使用注释

注释不能替代解释英文书写不好的代码的方法。编写结构良好且易读的代码,然后使用注释。

一些人认为代码应该是自我记录的,注释应该很少。但是,我必须完全不同意(这是我个人的观点)。使用注释来解释复杂的算法,正则表达式或方案(其中您选择了一种技术而不是另一种技术(以供将来参考))来解决问题没有什么错。

在大多数情况下,使用注释来解释“为什么”而不是“如何”,这样您就可以做好了。