KDoc 中的表？

Question

我们的 Java DTO 中通常有更新日志，其中包含 Java 文档中定义的 table：

/**
 * 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 的文档，上面写着：

For inline markup, KDoc uses the regular Markdown syntax, extended to support a shorthand syntax for linking to other elements in the code.

所以我尝试使用 Markdown 语法创建一个 table：

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

但这呈现（再次使用 Intellij 预览）：

这看起来不像 table。

我也试过只使用 HTML table 但这也不起作用。

问题

KDoc 是否支持 tables，如果支持，您如何创建一个？

Answer 1

目前 KDoc 不支持表格 - Github and Youtrack

上有未解决的问题

有一些解决方法 - 您可以用 ```（三重反引号）将文本括起来以保持缩进和格式

Answer 2

唯一的解决方法是使用 Markdown Tables Generator 生成 table。例如，

然后粘贴到您的文档中，

KDoc 中的表？

Tables in KDoc?

kotlin

kdoc