问题标签 [kdoc]

AFAIK Kotlin 的文档是使用 Dokka 制作的。但是Dokka 的自述文件中所述的示例仅生成超基本的网页/降价文件，没有任何优雅。

它看起来像这样

这是Atrium的另一个，文档链接。

我想知道我是否做错了什么。

我还查看了问题页面并浏览了其他使用Dokka的开源 github 项目，结果始终相同。

现在一个很好的例子说明如何生成漂亮的文档的工具是Jazzy by Realm for Swift/Obj-C。使用它就像在终端上运行一个命令一样简单。

这是使用 Jazzy 创建的示例文档

进一步的研究表明，我可能必须使用Gitbook或Jekyll等第三方工具来生成我正在寻找的那种文档，这真的是唯一的方法吗？

我的object项目中有以下内容

如您所见，我想PARAM在该方法的 KDoc 注释中引用该字段的值，appendParameter但是在查看该注释时，我看不到实际值，而只看到该字段的名称。

将 PARAM 参数附加到 url 的方法

我想要的是：

将任何参数附加到 url 的方法

在 Javadoc 中，这通过 using 起作用，{@value PARAM}但在 KDoc 中似乎没有类似的东西。甚至自动代码转换器也保留了旧的 Javadoc。

所以我的问题是：是我遗漏了什么还是 KDoc/Dokka 遗漏了这个功能？

我想知道是否有可能将类的静态字段的值包含到类方法的文档中。

我们可以通过方括号链接类成员和参数：

目标

但我想MAX_TITLE_LENGTH在方法文档中有值，而不是指向其名称的链接。

为了完整起见，这是我的类定义：

提前致谢。

Kotlinlang.org 说一个单独的 markdown 文件记录了所有的包。在 intellij idea 项目中是否有该降价文件的规范路径？有没有一种规范的方法可以用 gradle 处理该文件？有没有办法将这些 .md 文件与 .kt 文件放在包目录中？

我想离线运行 Dokka 来生成文档，因为构建运行系统不需要互联网访问，因此需要离线生成文档。

可能吗？如果是，请提出相同的建议。

谢谢比奈

由于它似乎无法离线工作，因此没有可用的信息。

如何将（经过测试的、非陈旧的）代码示例包含到 Dokka 包文档中？

更具体地说，假设我在我的build.gradle.kts：

然后是一些测试代码：

还有一个包文档 Markdown 文件：

，如何将println(...)-part 包含到文档中？当前版本的 Dokka 是否完全支持它？

交换或替换#没有做任何事情。.@sample@includeFunction

此外：

• 这是一个相关的问题，将近两年没有回答。
• 这是 2012 年的一些讨论，现在几乎完全由死链接组成。

我有一个带有辅助构造函数的 Kotlin 类，应该在特定场景中使用。现在这应该从第一个构造函数中正确记录，以便您可以立即看到它。

我一点也不知道在方括号中放什么用于引用成员/函数，但我觉得应该是可能的。如果有人对此了解更多，那就太好了

我有一个带有注释的方法的spring boot项目，例如：

当我使用 dokka 生成 kdoc 时，PreAuthorize不包含注释。这是生成的kdoc：

有没有办法在生成的文档中包含注释？

我在 Kotlin的伴生对象中有以下参数

问题是，在Kdoc结果中，我按字母顺序找到它们

ARTIST_IDS_KEY

const val ARTIST_IDS_KEY：字符串

CONNECTION_AUX

const val CONNECTION_AUX：字符串

CONNECTION_蓝牙

const val CONNECTION_BLUETOOTH：字符串

CONNECTION_KEY

设备可以具有的各种连接类型的值。

const val CONNECTION_KEY：字符串

连接_USB

const val CONNECTION_USB：字符串

DEVICE_ID_KEY

设备和媒体元素的唯一 ID。

const val DEVICE_ID_KEY：字符串

GENRE_IDS_KEY

const val GENRE_IDS_KEY：字符串

MEDIA_ID_KEY

const val MEDIA_ID_KEY：字符串

MEDIA_NAME_KEY

您可以在 getMediaItems 返回的 Bundle 中找到各种键。

const val MEDIA_NAME_KEY：字符串

SONG_IDS_KEY

const val SONG_IDS_KEY：字符串

...有没有办法维持原始订单？

考虑这个 Kotlin 类的类注释：

我希望第二个链接指向第二个函数（具有两个参数的函数）。

这在 Kotlin 文档语言中是否可行？