我们的 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 表格,但这也不起作用。
Question
KDoc 是否支持表,如果支持,如何创建一个表?
目前 KDoc 不支持表格 - 有问题在Github and Youtrack
有某种解决方法 - 您可以用```(三个反引号)保持缩进和格式
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)