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

时间:2016-01-06 11:29:37

标签: android javadoc kotlin kdoc

我正在撰写文档评论来描述一种方法。

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

但它不会显示段落。如果我不使用<p>,则所有文档都在一行中没有任何中断。 它适用于Java类,但是当谈到Kotlin时,我不知道如何处理它。

1 个答案:

答案 0 :(得分:11)

documentation中所述,KDoc(相当于Kotlin中Java的JavaDoc)使用常规Markdown syntax代替HTML标记。

在Markdown中,段落只是用空行拆分,如下所示:

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

另外,请参阅Kotlin参考文献中的this example