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

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

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

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


kotlin kdoc kotlin-dokka
person Dmitry Ryadnenko    schedule 07.02.2019    source источник

Ответы (2)


arrow_upward
5
arrow_downward

Вы должны сделать это с помощью символа `, например:

 /**
  * @param scrollFraction In range `[0..1]`.
  */
person Demigod    schedule 07.02.2019
comment
Это также набирает содержимое внутри обратных кавычек кодовым шрифтом вместо обычного шрифта. Поэтому этот ответ решает проблему вопроса, представляя при этом свою собственную проблему. - person Erik; 21.10.2020

arrow_upward
4
arrow_downward

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

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

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

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

person yuvgin    schedule 07.02.2019