KDoc语法
- 像 Javadoc 一样,KDoc 注释也以
/**
开头、以*/
结尾。注释的每一行可以以星号开头,该星号不会当作注释内容的一部分。文档文本的第一段(到第一行空白行结束)是该元素的总体描述,接下来的注释是详细描述。每个块标签都以一个新行开始且以@
字符开头。 - 示例:
/** * 一组*成员*。 * * 这个类没有有用的逻辑; 它只是一个文档示例。 * * @param T 这个组中的成员的类型。 * @property name 这个组的名称。 * @constructor 创建一个空组。 */ class Group<T>(val name: String) { /** * 将 [member] 添加到这个组。 * @return 这个组的新大小。 */ fun add(member: T): Int { …… } }
- 块标签:KDoc目前支持以下标签
- @param 名称:用于函数的值参数或者类、属性或函数的类型参数。
- 有以下两种语法
-
@param name 描述。 @param[name] 描述。
- @return:用于函数的返回值。
- @constructor:用于类的主构造函数
- @receiver:用于扩展函数的接收者
- @property 名称:用于类中具有指定名称的属性。这个标签可用于在主构造函数中声明的属性,当然直接在属性定义的前面放置 doc 注释会很别扭。
- @throws 类、@exception 类:用于方法可能抛出的异常。因为 Kotlin 没有受检异常,所以也没有期望所有可能的异常都写文档,但是当它会为类的用户提供有用的信息时, 仍然可以使
- @param 名称:用于函数的值参数或者类、属性或函数的类型参数。