Comment ajouter des éléments de mise en forme tels que le gras, l'italique, le soulignement, etc. à la documentation Kotlin (KDoc) ?

Question

J'ai trouvé la page Documenter le code Kotlin dans la référence officielle de Kotlin.

Pourtant, je n'ai pas trouvé comment mettre en évidence certaines parties de la documentation, par exemple en les marquant en italique ou en gras.

Je suis nouveau dans Kotlin, je viens de Java et je n'ai utilisé auparavant que JavaDoc, où l'on utilisait <i> y <b> Balises HTML pour mettre en évidence certaines parties de la documentation.

Answer 1

En écrivant cette question, j'ai trouvé la réponse. Je suis bête, le lien que je cherchais était même sur la page que j'ai référencée dans la question.

Je vais donc écrire une réponse à ma propre question, afin que quelqu'un d'autre puisse en profiter à l'avenir.

La documentation indique :

Balisage en ligne Pour le balisage en ligne, KDoc utilise l'option régulière Markdown étendue pour prendre en charge une syntaxe abrégée permettant d'établir des liens avec d'autres éléments du code.

Ainsi, pour souligner quelques points de Markdown :

• Markdown traite les astérisques ( * ) et les tirets bas ( _ ) comme indicateurs d'importance. Le texte entouré d'un * o _ sera entouré d'un code HTML <em> tag ; double * ou _ seront entourés d'un code HTML <strong> étiquette. En règle générale, un simple astérisque donne comme résultat italique tandis que l'astérisque double donne lieu à en gras .
• Les en-têtes peuvent être lancés avec # (h1), ## (h2), ou ### (h3). Par exemple : # This is an H1
• Le code peut être enveloppé dans des backticks
• Les citations commencent par une flèche vers la droite ( > )
• Markdown prend également en charge les listes ordonnées et non ordonnées.
• ... et plus