Kotlin 注释

提示

注释类型：Kotlin 支持两种类型的注释：多行注释 /* ... */ 可跨越多行，用于较长的说明或文档；行尾注释 // ... 用于行末尾，适合简短的说明或备注。
Kotlin 注释的作用：在 Kotlin 中，注释用于提供对代码的解释和理解，对编译器无影响，且可以用于记录代码的功能、特定实现的理由或标记待完成的工作。
注释的正确使用：注释应用于阐释代码的复杂部分，如复杂算法或技术选择的理由，而不是替代清晰的代码结构。主要目的是解释代码的“为什么”而非“如何”，从而帮助理解并维护代码。

在编程中，注释是程序的一部分，旨在帮助你和你的同事理解代码。它们被 Kotlin 编译器（Kompiler）完全忽略。

与 Java 类似，Kotlin 有两种类型的注释：

多行注释 /_ ... _/

这是一个可以跨越多行的多行注释。Kotlin 编译器会忽略从 /* 到 */ 的所有内容。例如，

/* 这是一个多行注释。
 * 程序在标准输出上打印 "Hello, World!"。
 */
fun main(args: Array<String>) {

   println("Hello, World!")
}

多行注释也用于用小小的变化记录 Kotlin 代码（KDoc）。KDoc 注释以 /** 开始，以 */ 结束。

编译器会忽略从 // 到该行末尾的所有内容。例如，

// Kotlin Hello World 程序
fun main(args: Array<String>) {

   println("Hello, World!")      // 在屏幕上输出 Hello, World!
}

上述程序包含两个行尾注释：

// Kotlin Hello World 程序

和

// 在屏幕上输出 Hello, World!

注释不应该是用来解释用英语编写的糟糕代码的替代品。编写结构良好且可读性强的代码，然后使用注释。

有些人认为代码应该是自我记录的，注释应该很少。然而，我完全不同意这个观点（这是我的个人意见）。使用注释来解释复杂的算法、正则表达式或在解决问题时选择了一种技术而不是另一种技术的场景（用于将来参考）没有什么不对。

在大多数情况下，使用注释来解释“为什么”而不是“如何”，你就可以开始了。