标签: kdoc

Kotlinlang.org 说，一个单独的Markdown文件记录了所有包。在 intellij 创意项目中，该 Markdown 文件是否有规范路径？有没有一种规范的方法来使用 gradle 处理该文件？有没有办法将这些 .md 文件与包目录中的 .kt 文件放在一起？

在我的 kDoc 中，我想要段落之间有一个空行。我该如何做到这一点？（还有什么地方有完整的指南吗？比如如何创建表格、项目符号等？）

在JavaDoc中，我可以将超链接表示为@see <a href="http://google.com">http://google.com</a>。在科特林如何做到这一点？

考虑这个非扩展函数：

fun checkArguments(expression: Boolean) {
    if (!expression) {
        throw IllegalArgumentException()
    }
}

当我在kotlin和java中使用这个函数时，我可以看到它的参数名称：expression。

我还可以将相同的功能编写为扩展函数：

fun Boolean.checkArguments() {
    if (!this) {
        throw IllegalArgumentException()
    }
}

当我以这种方式将其编写为扩展函数时，调用它的布尔值的参数名称（this函数内的变量，又称接收器）显示为$this$checkArguments。如何为此参数添加 KDoc 文档注释？使用@param $this$checkArguments似乎没有记录它。

由于KDoc文档生成引擎被放弃以支持Dokka,Kotlin文档应该被称为"KDoc评论",还是"Dokka评论"？

在Android Studio中工作之前如果在我放入/**并按下回车的函数之前,那么我会自动生成带有注释的下一个文档来描述参数,返回值等.

/**
* @params a
* @return
*/
int f(int a)
{
    return a;
}

当我开始在Android Studio中使用Kotlin时,我尝试生成一个类似的模板,它生成没有返回的空白模板,params等.

   /**
    *
    */
    fun f(a: Int)
    {
       return a
    }

我安装了Dokka并试图在Android Stuio中进行设置,但它没有用.如何在Android Studio中为Kotlin配置类似模板的生成？

试图用一个非常常规的结构来记录一些Kotlin代码:

1. 编号列表.
   • 带有项目符号子列表.
2. 数字在列表的顶层正确继续的位置.

我所采取的官方Dokka页面甚至没有页面上的"列表"一词.谷歌搜索没有找到任何关于如何做到这一点的信息.救命!

我想添加这样的评论

  /**
   * @param scrollFraction In range [0..1].
   */

但是Dokka / Kdoc将方括号内的内容解释为参考。当您在IDE中检查函数的文档或生成文档时，这会导致注释呈现效果很差。如何在Dokka / Kdoc中转义方括号/其他符号？