问题标签 [kdoc]

我注意到使用#or ##or####是等价的......总是会这样吗？

有时我只想使用“#”，因为它更方便，只要它以后不会变得更大。

我不确定这是否适用于生成的文档，因为我不知道如何生成它，我只找到了命令行指令，但肯定有一种我还没有找到的 IDE 更简单的方法。

我正在使用 dokka 为我自动生成 javadoc。尽管当它遇到不是我的项目中的任何类时，它使用完全限定的名称。

是否可以只使用类名并让 dokka 为其提供链接？例如：

我想要而不是java.lang.String链接String到Java doc

我的毕业配置：

另外，究竟是linkMapping什么？我不确定它的作用。

给定以下代码

如何引用特定函数？即example()或example(String)？

使用[example]我无法指定我想要的确切功能。

我正在尝试记录一个方法并尝试在JavaDoc@link中使用and 。@code

我知道在 kotlin 中有一个kDoc，但我找不到它们，或者至少找不到类似的东西。

我目前正在测试 Dokka 文档，并且我所做的一些注释没有被呈现。以下是我的发现：

1. 类不显示@sample，和 html 标签<p></p>，<h1></h1>：参见 SimpleCalculator类文档
2. 如果描述在 html 标记下，则不会显示：参见enum class OPERATOR代码文档
3. 方法不显示@sample并且根本不显示@property：查看所有方法代码文档
4. @property和之间的混合定义@param。在类声明中， the@param是在 a 中的那个<>（例如Group<T>）。但在方法中，它是参数里面的那个。

请看我的代码：

我的顶级构建文件：

我的项目构建文件：

输出：

有人可以帮忙吗？

我试图隐藏一个应该只对测试使用可见的方法。

javadoc是否有任何等价物@hide

我不是使用 KDoc 和 JavaDoc 的专家，如果我缺少任何概念，请指出我。

之前在 Android Studio 中工作，如果在我输入 / ** 并回车的函数之前，我会自动生成下一个文档，其中包含用于描述参数、返回值等的注释。

当我开始在 Android Studio 中使用 Kotlin 时，我尝试生成一个类似的模板，它会生成没有返回、参数等的空白模板。

我安装了 Dokka 并尝试在 Android Stuio 中进行设置，但没有成功。如何在 Android Studio 中为 Kotlin 配置类似模板的生成？

在 Kotlin v1.1+ 中，有声明类型别名的选项，它为现有类型提供替代名称。这对于函数类型特别有用 - 例如：

并且可以像其他成员一样使用 KDoc 评论记录它们：

但是有记录函数类型的参数和返回类型的特定方法吗？

Kotlin 网站提供了有关记录 Kotlin 代码的信息，但没有提及类型别名。

就像函数本身一样，如果函数类型可以这样记录，那就太好了：

但在 KDoc 中无法识别这些标签。

那么应该如何记录参数和返回类型呢？

尝试用非常常规的结构记录一些 Kotlin 代码：

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

我认为是Dokka 官方页面的页面上甚至没有“列表”一词。谷歌四处搜索，但没有找到任何有关如何执行此操作的信息。帮助！

假设我们有这样的记录字符串

这里有几个<br/>，我用来断行，就像我在 java 中所做的那样，但AndroidStudio的输出（在InteliJIdea中似乎相同）是

使用 java 可以正确解析和显示：

我可以用 kotlin 和 IntelijIdea 以某种方式实现相同的效果吗，也许 kotlin 有另一种选择来打破 KDoc 中的界限？