如何在 kotlin 注释中写入“/*”？

Question

如何在span代码的kotlin注释中写入

/*

？

例如：

/**
 * Defines the route `/route/*`
 */
fun defineRoute() { 
    /* ... */ 
}

现在，根据 Kotlin 的说法，

/route/*

是嵌套注释的开始（因此整个文件都被注释了）。我现在正在使用

/route/{*}

，但这不是一个不错的解决方案。

Answer 1

您也可以关闭嵌套评论：

/**
 * Defines the route `/route/*`
 */*/
fun defineRoute() { 
    /* ... */ 
}

这样做的好处是，一旦他们修复了 Kotlin 解析器，就会被破坏，并提醒删除它们。

Answer 2

您可以使用 HTML 转义，因此在您的示例中：

/**
 * Defines the route /route/*
 */
fun defineRoute() { 
    /* ... */ 
}

应该达到预期的结果，因为

/

作为“/”转义

Answer 3

这是 Kotlin 的一个缺陷。请在 Kotlin 问题跟踪器中 +1 KT-28979 以帮助确定修复的优先级。

与此同时，这里有一些有趣的解决方法：

使用 HTML 注释转义

*/

您可以在 Markdown 中使用 HTML 注释来隐藏前面的

/**

，以“转义”结尾的

*/

。

使用

<pre>

标签来格式化代码。

/**
 * Hello, welcome to the KDoc for the [a] property.
 *
 * Blah blah
 * <!-- /** --> <code>*/*</code>
 * foo bar.
 */
val a = ""

使用Dokka渲染：

零宽度空间

在 * 和

/

之间插入

零宽度空格

以防止 Kotlin 解析它。

/**
 * Hello, welcome to the KDoc for the [a] property.
 *
 * `*​/​*`
 */
val a = ""

Web 浏览器不会显示 ，但它们在某些 IDE 中可见：

使用 ZWSP 并不理想，因为它会影响代码的意图。它仅适用于转义 KDoc 内容中的

*/

，这些内容仅供查看，而不是由用户复制（如命令或代码）。

Answer 4

您可以在 /* 之前添加反斜杠，如下所示：

/* say something \/*
*/
fun defineRoute() { 
/* ... */ 
}