Таблицы в 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 preview):

Который не похож на стол.

Я также пытался просто использовать таблицу HTML, но это тоже не работает.

Вопрос

Поддерживает ли KDoc таблицы, и если да, то как их создать?

Answer 1

В настоящее время KDoc не поддерживает таблицы - есть проблемы, открытые на Github и Youtrack

Существует какой-то обходной путь - вы можете заключить текст в `` ` (тройные обратные символы), чтобы сохранить отступы и форматирование

Answer 2

Единственный обходной путь - создать таблицу с помощью генератора таблиц уценки. Например,

https://s tackru.com/images/ec078316b2c238b22a511532c887d0d91436e309.png

Затем вставьте в свою документацию,

https://s tackru.com/images/57229037eb9fe572003a8285c3e4959eafb0ff3e.png