Как экранировать символы в документации Kotlin Dokka / Kdoc?

Question

Я хочу добавить такой комментарий

  /**
   * @param scrollFraction In range [0..1].
   */

Но Dokka / Kdoc интерпретирует вещи в квадратных скобках как ссылку.Это приводит к плохому отображению комментариев, когда вы проверяете документацию функции в IDE или генерируете документы.Как я могу избежать квадратных скобок / других символов в Dokka / Kdoc?

Answer 1

Вы можете использовать экранирование HTML:

 /**
   * @param scrollFraction In range [0..1].
   */

должно выводиться в Dokka как range [0..1]., поскольку [ экранируется как [, а ] экранируется как ].

Обратите внимание, что это не будет работать внутри секции встроенного кода (между серьезными акцентами - like this).
Для таких случаев обычно используйте квадратные скобки ([и]), как это было предложено в Ответ Полубога .

Answer 2

Вы должны быть в состоянии сделать это, используя символ `, например так:

 /**
  * @param scrollFraction In range `[0..1]`.
  */