KDoc:插入代码片段

53

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

在 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个回答

100

您可以使用三个反引号:

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

1
波浪号(~~~)也可以使用。这样打起来可能更容易。 - ceving

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接