KDoc:插入代码段

时间:2016-11-03 11:40:46

标签: documentation kotlin kdoc

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

在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 个答案:

答案 0 :(得分:37)

你可以使用三重反推:

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