KDoc中的桌子？

Question

我们的Javadoc中通常有一个由Javadoc中定义的表组成的changelog：

/**
 * Changelog:
 *
 * <table>
 *     <tr><th>Version</th><th>Description</th></tr>
 *     <tr>
 *         <td>2</td>
 *         <td>Added field 'something'</td>
 *     </tr>
 *     <tr>
 *         <td>3</td>
 *         <td>Added field 'somethingElse'</td>
 *     </tr>
 * </table>
 */
public class MyDTO {
 ...
}

这将(在Intellij中使用Javadoc预览)很好地呈现如下所示：

​

​

现在，我们想对我们的Kotlin数据类做同样的事情。阅读KDoc的文档，上面写着：

对于内联标记，KDoc使用常规的Markdown语法，扩展为支持链接到代码中的其他元素的速记语法。

因此，我尝试使用Markdown语法创建一个表：

/**
 * Changelog:
 *
 *| Version       | Description                 |
 *| ------------- | --------------------------  |
 *| 2             | Added field 'something'     |
 *| 3             | Added field 'somethingElse' |
 *
 */
data class MyKotlinDTO(..) { 
    ...
}

但是这个呈现(再次使用Intellij预览)：

​

​

看起来不像一张桌子。

我也尝试过只使用HTML表，但这也不起作用。

问题

KDoc支持表吗?如果支持，那么如何创建表？

Answer 1

目前，KDoc不支持表--在Github和Youtrack上存在打开的问题

有一种解决办法--您可以用` (三重回退)环绕文本，以保持缩进和格式化。

Answer 2

唯一的解决办法是用标记表生成器生成一个表。例如,

​

​

然后粘贴到你的文档中

​

​