KDoc: Insert code snippet

Question

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

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 {}

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

yole · Accepted Answer · 2016-11-03 11:47:24Z

118

You can use triple backticks:

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

answered Nov 3, 2016 at 11:47

yole

98k21 gold badges279 silver badges205 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

ceving Over a year ago

Tilde (~~~) works, too. It might be easier to type.

Collectives™ on Stack Overflow

KDoc: Insert code snippet

1 Answer 1

1 Comment

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Linked

Related