KDoc：插入代码片段

Posted 2023-03-05

【中文标题】KDoc：插入代码片段

【英文标题】：KDoc: Insert code snippet

【发布时间】：2017-03-16 23:37:12

【问题描述】：

如何在 Kotlin 的默认文档工具 KDoc 中插入代码 sn-p？

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

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

在 Kotlin 中似乎没有等价物。我尝试使用 Markdown，但在行尾后插入 2 个空格不会换行。

【参考方案1】：

您可以使用三个反引号：

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