KDoc:插入代码段 [英] KDoc: Insert code snippet

问题描述

如何在Kotlin的默认文档工具KDoc中插入代码段?

How do I insert a code snippet in KDoc, Kotlin's default documentation tool?

在Java中，我可以使用以下内容:

In Java, I can use the following:

/**
 * Example usage:
 *
 * <pre>
 * <code>&#64;JavaAnnotation
 * public void foo() {
 *     // Code
 * }
 * </code>
 * </pre>
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface JavaAnnotation {}

在Kotlin中似乎没有同等的东西.我尝试使用Markdown，但是在行尾插入2个空格不会换行.

There seems to be no equivalent in Kotlin. I tried using Markdown, but inserting 2 spaces after line end does not line-break.

推荐答案

您可以使用三次反引号:

You can use triple backticks:

/**
 * Example usage:
 *
 * ```
 * @JavaAnnotation
 * public void foo() {
 *     // Code
 * }
 * ```
 */

这篇关于KDoc:插入代码段的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！