documentation - KDoc:插入代码片段

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

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

最佳答案

您可以使用三个反引号:

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

关于documentation - KDoc:插入代码片段,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/40400593/

相关文章:

kotlin - 如何更改默认推断没有接收者的函数类型?

kotlin - 如何在 kDoc 中表示超链接

scala - 查找 Scala Array 深层文档?

Python 3 文档 - 函数注解

documentation - 如何从 Cucumber/Gherkin 生成文档?

c++ - 我在哪里可以找到 C++0x 同步原语的良好、可靠的文档?

java - 确定季度边界日期的更好方法

java - 如何仅通过提供大小来像在 Java 中一样在 Kotlin 中创建数组?

kotlin - KDoc常量引用值

kotlin - KDoc:更改参数顺序