ktdoc 中如何使用“@sample”？

Question

我想在我的 Kotlin 文档中提供代码示例，我发现 the documentation 中有一个 @sample <identifier> 关键字。但是我不确定我应该做什么。

Answer 1

您在 ktdoc 块中使用 @sample <identifier>。

<identifier>是示例函数的全名。

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

/**
 * 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")
  }
}

ktdoc 中如何使用“@sample”？

How is `@sample` used in ktdoc?

kotlin

kotlin-dokka