KDoc中的表格？

Question

我们的Java DTO中通常包含一个由Javadoc中定义的表组成的更改日志:

/**
 * 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上打开了问题

有一些解决方法 - 你可以使用```(三重反引号)来包围文本以保持缩进和格式化