12、Kotlin编程：注释、流程控制与作用域函数详解

Kotlin编程：注释、流程控制与作用域函数详解

1. 函数与属性注释

在Kotlin中，为函数和属性添加注释的方式与为类添加注释基本相同。只需在想要注释的任何函数或属性前面添加 /** ... */ 即可。和类文档一样，每行以任意数量的空格和一个星号开头，内部再次使用Markdown代码。示例如下：

class SomeClass {
    /**
    * This describes property prop
    * ...
    */
    val prop:Int = 7
    /**
     * This describes function func
     * ...
     */
    fun func() {
        ...
     }
}

对于类、接口和单例对象，此类文档的第一段应提供简短摘要，因为工具可能会将其用于列表显示。

对于属性，还可以使用以下额外元素：
- @sample <specifier> ：插入指定函数的代码。
- @see <specifier> ：添加到指定标识符（类、接口、单例对象、属性或方法）的链接。
- @author description ：添加作者信息。
- @since description ：添加有关文档化元素存在时间的信息（版本信息等）。
- @sup