12得票1回答
如何为文件添加顶级KDoc?

有没有办法为Kotlin文件添加一个顶层的KDoc? 由于Kotlin支持在单个文件中定义多个变量、函数、类等,因此将整个文件进行文档化是有意义的。然而,文档化Kotlin代码-Kotlin编程语言似乎没有提供任何关于如何实现这一点的说明。

11得票1回答
Kotlin文档不太支持像'<p>'这样的标签。

我正在编写文档注释来描述一个方法。 /** * &lt;p&gt;necessary * &lt;p&gt;setType is to set the PendingIntend's request code&lt;/p&gt; */ 但它不会显示段落...

10得票1回答
如何在Jitpack上使用maven发布Kotlin库的KDoc?

背景 经过大量的研究、尝试和寻求帮助,我成功地使用 Maven 在 Jitpack 上发布了一个私有 Github 仓库(在这里写明 here)。 目前,在我为 Jitpack 准备的仓库中只有以下这些文件: jitpack.yml - 告诉系统应该使用哪些文件 library-releas...

10得票1回答
Kotlin:如何使用@see在kDoc中引用方法?

我曾经这样引用Java Doc中的方法: /** * @see com.myapp.view.fragment.PlaybackControlFragment#onPlaybackStateChanged */ 我不知道如何在 Kotlin 中引用相同的方法? 部分代码 com.m...

10得票2回答
Dokka:将代码示例包含在软件包文档中。

如何将(经过测试的,非陈旧的)代码示例包含到Dokka软件包文档中? 更具体地说,假设我在我的build.gradle.kts中有以下配置: withType&lt;DokkaTask&gt; { outputFormat = "html" outputDirector...

9得票1回答
Kotlin函数类型别名应该如何记录文档?

在 Kotlin v1.1+ 版本中,有一个声明 类型别名 的选项,它为现有类型提供了替代名称。这对于函数类型特别有用-例如: typealias OnItemClick = (view: View, position: Int) -&gt; Boolean 而且它们可以像其他成员一样使...

9得票1回答
将一个方法的KDoc文档复制到另一个方法

对于这两种给定的方法: /** * Adds a [DataItem] to the Android Wear network. The updated item is synchronized across all devices. */ fun putItem(){ .... } /*...

8得票2回答
KDoc中的表格?

通常我们在Java DTO中都会有变更日志,其中包含Javadoc中定义的表格: /** * Changelog: * * &lt;table&gt; * &lt;tr&gt;&lt;th&gt;Version&lt;/th&gt;&lt;th&gt;Description&...

8得票1回答
Kotlin:属性setter的文档

我是一名编写Kotlin库的开发者。在其中一个类中,我有以下代码: class SessionWrapper { /** * The time in milliseconds after which the session will expire. */ ...

7得票2回答
在Kotlin文件中放置文档说明的位置(不是包,不是模块,不是类)在哪里?

我应该在 Kotlin 源代码文件中放置注释的位置是哪里? 类和其他对象都有 KDoc: /** * Summary * * Rest of documentation goes here. */ class A { ... } 但是我应该把这样的东西放在哪里呢? /...