通常,我们的Java DTO中有一个changelog,其中包含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中的表?-LMLPHP

现在我们要为Kotlin数据类做同样的事情。阅读KDoc的文档,其中写着:



因此,我尝试使用Markdown语法创建表:
/**
 * Changelog:
 *
 *| Version       | Description                 |
 *| ------------- | --------------------------  |
 *| 2             | Added field 'something'     |
 *| 3             | Added field 'somethingElse' |
 *
 */
data class MyKotlinDTO(..) {
    ...
}

但这会渲染(再次使用Intellij预览):

kotlin - KDoc中的表?-LMLPHP

看起来不像桌子。

我也尝试过仅使用HTML表,但这也不起作用。

问题

KDoc是否支持表,如果支持,如何创建表?

最佳答案

当前,KDoc不支持表-Github Youtrack上存在一些问题

有一种解决方法-您可以使用```(三行反引号)将文本括起来,以保持缩进和格式

08-18 17:38