一、JavaDoc
在 Android Studio / IntelliJ IDEA 中为 Java 类和方法注释时，在类或方法上方键入 /** 并回车，Android Studio / IntelliJ IDEA 会为我们生成注释模板，方便我们快速添加注释。
/**
*
* @param name
* @return
*/
public String getName(String name) {
return "name:" + name;
}
这是因为 Android Studio / IntelliJ IDEA 中内置了 JavaDoc 插件（如果没有该插件也没关系，接着往下看，后面会介绍 KDoc 插件的安装，方法是一样的，你可以手动安装 JavaDoc 插件）。
JavaDoc是Sun公司提供的一个技术，从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。
进入 Code Style 这里可以配置 JavaDoc 格式。
除了可以快速生成注释模板，JavaDoc插件主要用来生成 API 文档。
Android Studio / IntelliJ IDEA 生成 JavaDoc 文档 ： Tools -> Generate JavaDoc
这不是本文的重点，如果想了解生成 JavaDoc 文档更多的知识，可以自行查阅资料。
二、KDoc
前面说到为 Java 类和方法注释时，在类或方法上方键入 /** 并回车，Android Studio / IntelliJ IDEA 会为我们生成注释模板，但当我们在 Kotlin 的类或方法上进行同样操作时，这并不起作用。
聪明的你可能已经猜到了原因：没有安装相关插件。
为 Kotlin 的类或方法快速生成注释模板，需要安装 KDoc 插件。
用来编写 Kotlin 代码文档的语言（相当于 Java 的 JavaDoc）称为 KDoc。本质上 KDoc 是将 JavaDoc 的块标签（block tags）语法（扩展为支持 Kotlin 的特定构造）和 Markdown 的内联标记（inline markup）结合在一起。
KDoc插件安装
- 进入设置：Mac: Android Studio(IntelliJ IDEA) -> Preferences (Windows: File -> Settings)
- 选择Plugins，在 Marketplace 上搜索找到 kdoc-generator
- 点击 Install 下载插件
- 安装完成后重启
重启后 kdoc-generator 插件已经成功安装到你的 Android Studio / IntelliJ IDEA 上。试试为 Kotlin 的函数生成 KDoc 注释，在类或方法上方键入 /** 并回车，效果如下：
/**
* TODO
*
* @param name
* @return
*/
fun getName(name: String): String {
return "name:" + name
}
到这里为 Android Studio / IntelliJ IDEA 中的 Kotlin 类和方法生成注释模板的配置工作就完成了。
三、Kotlin代码文档更多相关知识
和 JavaDoc 插件不同，kdoc-generator 插件仅能帮你生成注释模板，要生成 API 文档还需要 Dokka ，其使用说明请参见 Dokka README。
Dokka 是 Kotlin 的文档引擎，执行与 Java 的 javadoc 相同的功能。与 Kotlin 本身一样，Dokka 完全支持 Java / Kotlin 混合语言项目。它了解 Java 文件中的标准 Javadoc 注释和 Kotlin 文件中的 KDoc 注释，并可以生成多种格式的文档，包括标准 Javadoc，HTML 和 Markdown。
Dokka 有 Gradle、Maven 和 Ant 的插件，因此你可以将文档生成集成到你的构建过程中。
另外，如果你希望了解更多关于 KDoc 的知识，请点击这里。
