Kotlin 文档不支持像 '<p>' 这样的标签

Question

我正在写文档注释来描述一种方法。

   /**
     * <p>necessary
     * <p>setType is to set the PendingIntend's request code</p>
     */

但是它不会显示段落。如果我不使用 <p>，所有文档都在一行中，没有任何中断。在Javaclass里面可以用，但是到了Kotlin就不知道怎么处理了。

Answer 1

如 documentation, KDoc (equivalent of Java’s JavaDoc in Kotlin) utilizes regular Markdown syntax 中所述，用于内联标记而不是 HTML 标记。

在 Markdown 中，段落只是被一个空行分隔，像这样：

/**
 * necessary
 *
 * setType is to set the PendingIntend's request code
 */

此外，请参阅 Kotlin 参考资料中的 this example。

Kotlin documentation doesn't support tags like '<p>' well