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

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

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

Вопрос

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

Answer 1

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

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

Answer 2

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

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