Kotlin ktdoc中如何使用“@sample”？

我想在我的Kotlin文档中提供代码示例，我发现其中有一个

@sample

关键字。但是我不确定我应该做什么。

您在ktdoc块中使用

@sample

是示例函数的全名

示例函数包含要显示的所有代码。这样编译器就会验证代码

/**
 * Creates an [Iterator] for an [java.util.Enumeration], allowing to use it in `for` loops.
 * @sample samples.collections.Iterators.iteratorForEnumeration
 */
@kotlin.jvm.JvmVersion
public operator fun <T> java.util.Enumeration<T>.iterator(): Iterator<T> = object : Iterator<T> {
    override fun hasNext(): Boolean = hasMoreElements()

    public override fun next(): T = nextElement()
}

@Sample
fun iteratorForEnumeration() {
  val vector = Vector<String>().apply {
    add("RED")
    add("GREEN")
    add("BLUE")
  }
  for (e in vector.elements()) {
    println("The element is $e")
  }
}

/**
*为[java.util.Enumeration]创建一个[Iterator]，允许在`for`循环中使用它。
*@sample.collections.Iterators.iteratorForEnumeration
*/
@kotlin.jvm.jvm版本
公共运算符fun java.util.Enumeration.iterator（）：iterator=object:iterator{
重写fun hasNext（）：Boolean=hasMoreElements（）
public override fun next（）：T=nextElement（）
}
@样品
有趣的迭代器forenumeration（）{
val vector=vector（）。应用{
添加（“红色”）
添加（“绿色”）
添加（“蓝色”）
}
对于（vector.elements（）中的e）{
println（“元素为$e”）
}
}