问题标签 [kdoc]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
5513 浏览

kotlin - Kotlin KDoc:文档?

在这里看到了KDoc的引用,KDoc 是 Kotlin 的 JavaDoc 实用程序等价物。

但是,我找不到任何关于如何使用它的文档,更不用说如何自定义它或将它集成到 Maven 或 Gradle 中了。

我知道Kotlin API 文档是使用 KDoc 生成的,因为页面源具有以下 HTML 注释:<!-- Generated by kdoc on Sun Jul 06 20:27:33 UTC 2014 -->

那么,是否有任何关于如何使用 KDoc 的文档可供参考?

0 投票
1 回答
437 浏览

kotlin - 如何链接到 KDoc 中 Java 类的静态成员?

在 KDoc 中,您可以这样做:

但你不能这样做:

“你不能”是指如果你对静态成员使用Navigate → Declaration操作,IntelliJ IDEA 不会引导你声明静态成员。导航到静态字段也不起作用。

有没有办法链接到 KDoc 中 Java 类的静态成员?这可能只是 IDEA 中的一个错误吗?

0 投票
1 回答
245 浏览

kotlin - Kotlin 内联文档的正确名称是什么?

既然 KDoc 文档生成引擎被Dokka 所取代,那么 Kotlin 文档应该被称为“KDoc 注释”还是“Dokka 注释”?

0 投票
1 回答
880 浏览

android - Kotlin 文档不支持像 ' 这样的标签

' 好

我正在写文档评论来描述一种方法。

但它不会显示段落。如果我不使用<p>,则所有文档都在一行中,没有任何中断。它在 Java 类中工作,但是当涉及到 Kotlin 时,我不知道如何处理它。

0 投票
1 回答
1999 浏览

documentation - 您在哪里/如何为 Kotlin 包添加文档?

在 Java 中,如果你想记录一个包,它必须被放入 package-info.class 文件中。Kotlin 和 KDoc 还是一样吗?我查看了一些 Kotlin 源代码,但找不到他们的包文档是在哪里编写的。

0 投票
1 回答
856 浏览

intellij-idea - kotlin 未解析的 KDoc 链接,但 IntelliJ 不喜欢修复它的导入

我在 IntelliJ 中有与上述类似的东西......但它会将导入识别为未使用- 因此优化导入将删除它......但是,如果我不手动插入该导入,那么在我的文档中它将识别 [MyClass .MyEnum]无法解析

我能做些什么?

0 投票
1 回答
4446 浏览

javadoc - 如何继承 KDoc 文档?

在 Java 的 Javadoc 中,有一种方法可以使用{@inheritDoc}tag在子类中继承方法的文档。

有没有办法在 Kotlin 的 KDoc 中做同样的事情?

基本上,我想做的是以下几点:

0 投票
1 回答
570 浏览

kotlin - 将 KDoc 文档从一种方法复制到另一种方法

对于两个给定的方法:

是否有可能复制/链接第二种方法的文档与第一种方法相同?

手动复制粘贴 KDOC 并不是很好,因为如果您更新其中一个,则第二个很可能会意外过时。

0 投票
1 回答
236 浏览

gradle - 将多个源语言文档合并到一个 Javadoc JAR

如果我有一个项目,其中应用了javagroovykotlin插件,并且每个插件都编写了代码,我该如何创建(并且应该)创建一个javadoc.jar包含所有代码文档的单一发行版?

java插件给了我javadoc课程,插件groovy给了我groovydoc任务,但这些似乎并不配合。

我如何将这个文档“合并”成一个单一的有凝聚力的工件?

0 投票
1 回答
6282 浏览

documentation - KDoc:插入代码片段

如何在 Kotlin 的默认文档工具 KDoc 中插入代码片段?

在 Java 中,我可以使用以下内容:

Kotlin 中似乎没有等价物。我尝试使用 Markdown,但在行尾后插入 2 个空格不会换行。