KDoc 中的表?

2023-11-24

我们的 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 预览)很好地呈现为如下所示:

enter image description here

现在我们想对 Kotlin 数据类做同样的事情。阅读以下文档KDoc它说:

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

所以我尝试使用 Markdown 语法创建一个表:

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

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

enter image description here

这看起来不像一张桌子。

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

Question

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


目前 KDoc 不支持表格 - 有问题在Github and Youtrack

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

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

KDoc 中的表? 的相关文章

随机推荐

  • 禁用 jQuery 中的按钮

    我的页面创建多个按钮id rbutton i 下面是我的代码
  • Eclipse 错误:无法确定 /project-path/ 的 URI

    我在 VirtualBox 中的 Ubuntu 12 0 4 上使用 Windows 8 主机运行 Eclipse Luna 每隔一段时间 我就会启动 Ubuntu 并打开 Eclipse 来查找以下内容 我的项目应该列在包资源管理器中 但
  • python的“in”语言构造对于列表来说是线程安全的吗?

    Is obj in a list线程安全的同时a list可能会在不同的线程中修改 这是一个全面但非详尽的示例列表 of list操作以及它们是否是线程安全的 但是我找不到任何参考in语言构造 在 python 实现方面 我使用 CPyth
  • 简单的 html dom 抓取大型 html 文件

    我需要抓取一个大的 html 文件 例如 http www indianrail gov in mail express trn list html 使用简单的 html dom 我从一个简单的脚本开始 它什么也没显示 只是一个空白页 其中
  • 查找 TabStrip 索引

    是否可以在 KendoUI TabStrip 中找到选项卡的索引 我需要找到我选择的选项卡的索引 编号 并且我知道select 返回我当前的选项卡 但我不知道如何将其转换为数字 找到了解决方案 tabstrip data kendoTabS
  • VAO 是否会记住 EBO/IBO(元素或索引)和 VBO?

    我的代码正在正常工作 但这可能是一个巧合 我不想稍后再纠缠于错误 所以我试图尽可能保持它干净 我执行以下操作来初始化网格 生成并绑定 VBO 和缓冲区数据 生成并绑定 IBO 和缓冲区数据 生成并结合 VAO 绑定与之前相同的 VBO 在
  • 如何在Windows中异步打开文件

    有没有办法在 Windows 中异步打开文件 CreateFile API 函数只有 FILE FLAG OVERLAPPED 允许进一步异步读取和写入 尽管如此 文件的打开似乎是同步的 鉴于它必须访问文件系统 并可能执行昂贵的 IO 操作
  • 使用 fscanf 读取双精度

    我想从文本文件中读取双精度值 例如 31 39 9316476397222 116 113516352222 我两种都试过了 没用 我只能读取前几位十进制数字 例如39 93164 但不是 39 9316476397222 有人知道为什么吗
  • 无需光标即可在 Android Sqlite 中访问大型 BLOB

    Android 的光标窗口大小似乎有 1MB 的限制 这限制了从 SQLite 读取 BLOB 的能力 我知道您可能会说我们不应该将 BLOB 存储在数据库中 但根据定义 BLOB 被视为二进制大对象 如果不需要将它们存储在数据库中 则无需
  • 如何生成多重集的所有排列?

    多重集是一个集合 其中所有元素可能不唯一 如何枚举集合元素之间所有可能的排列 生成所有可能的排列然后丢弃重复的排列是非常低效的 存在各种算法来直接生成按字典顺序或其他类型的排序的多重集的排列 Takaoka 的算法是一个很好的例子 但 Aa
  • 编译后的 .lib 文件对于不同版本的 Microsoft Visual C++ 是否可以互换?

    有些项目为 C 以及可能的 C 不确定 库提供了一组 Windows 二进制文件 例如 请参阅右侧的链接这个 libxml 相关页面 我很确定没有办法在 VC lib 文件和 MinGW GCC a 文件之间进行转换 因此将它们称为 Win
  • 链接器命令失败,架构 i386 的符号未定义

    我正在尝试执行半页卷曲功能 这是我正在使用的代码 import
  • &**this 到底返回什么?

    这是指向调用对象的指针 它返回右值 这是一个指向调用对象的指针的指针 它返回地址的值 这是一个指向调用对象的指针的指针 这是对调用对象的指针的指针的引用 std vector
  • Google OR 工具 - 火车调度问题

    我试图解决的问题有点像这里的员工调度问题 https github com google or tools blob master examples python shift scheduling sat py 然而 有一些事情我被困住了
  • 对于 SQL Server 2005 表来说,多少列过多?

    我有一个请求 允许动态表拥有 1000 列 由我的最终用户随机选择 这对我来说似乎是个坏主意 这是一个可定制的表格 因此它混合了varchar 200 and float列 float 最适合应用程序 c double 类型 该数据库主要是
  • ASP.NET MVC 2 中带有约束的可选路由参数?

    如果我有这样的路线 routes Add new Route controller page new RouteValueDictionary page UrlParameter Optional new RouteValueDiction
  • JavaScript 数字开头为 0

    我只是想理解数字开头有 0 s 的 js 逻辑 例如 var x 09 3 here x 9 3 other example 09 3 9 3 returns true but check this one var x 02 5 Uncau
  • 如何在 Swing 应用程序中混合使用 Java Swing 和 JavaFX?

    我正在开发一个 Java Swing 应用程序 但我还想将 JavaFX 与 Swing 一起使用 有没有任何资源告诉您如何做到这一点 See here 简而言之 现在可以在 Swing 中嵌入 JavaFX 并通过以下方式获得支持JFXP
  • 解释 Swift 迭代器

    关于如何在 Swift 中制作生成器 或者迭代器因为它们在 Swift 中显然是这样称呼的 特别是如果您是该语言的新手 为什么有这么多发电机类型AnyIterator and UnfoldSequence 为什么下面的代码不这样做 它应该从
  • KDoc 中的表?

    我们的 Java DTO 中通常有变更日志 它由 Javadoc 中定义的表组成 Changelog table tr th Version th th Description th tr tr td 2 td td Added field