5

我们通常在我们的 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 是否支持表格,如果支持,您如何创建表格?

4

2 回答 2

8

目前 KDoc 不支持表格 - 在GithubYoutrack上打开了问题

有某种解决方法 - 您可以用```(三个反引号)包围文本以保持缩进和格式

于 2018-04-28T11:23:36.227 回答
3

唯一的解决方法是使用Markdown Tables Generator生成一个表。例如,

在此处输入图像描述

然后粘贴到您的文档中,

在此处输入图像描述

于 2019-05-10T06:43:11.147 回答