问题标签 [kdoc]

Kotlin 数据类中属性的 Javadoc 应该放在哪里？

换句话说，如何在 Kotlin 中编写以下 Java 代码：

在 Kotlin 中，它看起来像这样：

但是在哪里放置属性的文档？

我正在写一个 Kotlin 库。在其中一门课中，我有以下内容：

但是，如果他们修改（即调用 setter） ，updateExpiry(long)则其行为对 的客户应该是透明的。SessionWrapperexpiryTime

现在，对于 Kotlin 项目，这不是问题，因为我可以将额外的 KDoc 添加到expiryTime属性本身，并且不会觉得不合适：

但是对于 Java 项目，上面的文档会同时出现在setExpiryTime(long)和getExpiryTime()中，这感觉不对劲，因为我会在 getter 中使用 setter JavaDoc，在 setter 中使用 getter JavaDoc。

尝试通过以下方式在 Kotlin 中分离两个访问器的文档：

对于 Kotlin 和 Java 代码，只是在 IDE 中没有显示 JavaDoc。

我发现没有明确的方法可以尝试在KDoc 参考或Java interop page中分离 Java 可见的 getter 和 setter 的文档。

考虑到 Kotlin 与 Java 的良好互操作性，我觉得这很烦人。

将不胜感激任何想法。

我们通常在我们的 Java DTO 中有更新日志，其中包含在 Javadoc 中定义的表：

这会很好地呈现（在 Intellij 中使用 Javadoc 预览）如下所示：

现在我们想对 Kotlin 数据类做同样的事情。阅读KDoc的文档，上面写着：

对于内联标记，KDoc 使用常规 Markdown 语法，扩展为支持用于链接到代码中其他元素的速记语法。

所以我尝试使用 Markdown 语法创建一个表：

但这会呈现（再次使用 Intellij 预览）：

这看起来不像一张桌子。

我也尝试过只使用 HTML 表格，但这也不起作用。

问题

KDoc 是否支持表格，如果支持，您如何创建表格？

我正在使用 kotlin Spek 测试框架，并希望在我的文档中链接到规范。但是当引用 Spec IntelliJ 时，它告诉我它没有找到 Spec。这是可以理解的，因为 Spec 位于测试根目录中。但是有没有办法链接到规范，例如通过添加到文件的链接或其他东西？

I'm using Dokka v0.9.17 for Android. When I run ./gradlew dokka it generates the docs but it include so many packages that I don't care about like android.support.fragment and packages for all the third party libraries. How can I tell Dokka to only generate doc for my code?

How can I remove Dagger _Factory files from the doc?

My configuration is like this

我应该在哪里评论 Kotlin 源文件？

类和其他对象有 KDoc：

但是我应该把这样的东西放在哪里？

package申报前？之后呢？我应该使用 KDoc 注释/块注释/行注释吗？

有没有既定的约定？

我曾经像这样引用 Java Doc 中的方法：

我不知道如何在 kotlin 中引用相同的方法？

该部分com.myapp.view.fragment.PlaybackControlFragment已链接，但方法名称不可点击和链接。

什么是正确的语法？

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

In Java documentation I can do the following:

How do I do this in Kotlin doc for the same result of course?

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