1-0-注释

文档注释 注释内容通过 Dokka 工具被提取到 API 文档中。

Kotlin 的 SDK 默认不包含 Dokka 工具，需要自行下载。

常用参数

• -output <directory>：指定生成的 API 文档路径，默认是 out 目录。

• -format：指定生成文档的格式：

• html：最简 HTML 文档。

• javadoc：JavaDoc 风格。

• html-as-java：HTML，但使用 Java 语法。

文档注释示例

/**
 * 这是一个文档注释
 */

单行注释示例

//这是一个单行注释

嵌套注释示例

Kotlin 支持多行注释嵌套，而 Java 不支持。示例如下：

/*这是第一个多行注释开头
    /*这是第二个多行注释*/
这是第一个多行注释结尾*/

更多参数见 Dokka GitHub 项目。