KDoc:插入代码段

F. *_*rge 20 documentation kotlin kdoc

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

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

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

Kotlin似乎没有相应的东西.我尝试使用Markdown,但在行结束后插入2个空格不会换行.

yol*_*ole 43

你可以使用三重反推:

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

  • 波形符 (`~~~`) 也有效。打字可能会更容易。 (2认同)