Tag: kdoc

Kotlin KDoc:文档?

我在 这里看到, 在这里和那里引用了KDoc,相当于Kotlin的JavaDoc实用程序。 但是,我找不到有关如何使用它的任何文档,更不用说如何定制它或将其集成到Maven或Gradle中。 我知道Kotlin API文档是使用KDoc生成的,因为页面源代码有以下的HTML注释: 那么,有没有关于如何使用KDoc的文档呢?

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

在KDoc中,你可以这样做: /** * [Integer.equals] is an instance method. */ 但是你不能这样做: /** * [Integer.signum] is a static method. */ 通过“你不能”我的意思是说,IntelliJ IDEA不会引导你到一个静态成员的声明,如果你使用导航→宣言行动。 导航到静态字段也不起作用。 有没有办法链接到KDoc的Java类的静态成员? 这可能只是IDEA中的一个错误?

kotlin未解决的KDoc链接,但IntelliJ不喜欢导入修复它

import abc.MyClass.MyEnum; /// from Java /** * [MyClass.MyEnum] */ class efg () : MyClass.MyEnum { return MyClass.MyEnum.BiGNUMBER; } 我有类似于IntelliJ上面的东西…但它会确定导入为未使用 – 所以优化导入将删除它…但是,如果我不插入手动导入,然后在我的文档它将识别[MyClass .MyEnum] 不能解析 我能做什么?

在哪里/如何为Kotlin软件包添加文档?

在Java中,如果你想记录一个包,它必须放在package-info.class文件中。 Kotlin和KDoc仍然是一样的吗? 我已经浏览了Kotlin的一些源代码,并且找不到它们的包文档在哪里编写。

Kotlin – @javadoc相当于

我试图隐藏一个只能用于测试用法的方法。 javadoc的@hide是否有任何等价物@hide 我不是使用KDoc的专家,也不是使用JavaDoc,如果我错过了任何概念,请指向我。 /** @hide */ fun methodToHide() : String = “foo”

文档模板生成kotlin

之前在Android Studio中工作,如果在函数之前,我把/ **和回车,然后我自动生成的下一个文档,注释描述参数,返回值等 /** * @params a * @return */ int f(int a) { return a; } 当我开始在Android Studio中使用Kotlin时,我试图生成一个类似的模板,它生成没有返回,参数等的空白模板。 /** * */ fun f(a: Int) { return a } 我安装了Dokka并试图在Android Stuio中设置它,但是没有奏效。 如何在Android Studio中为Kotlin配置类似的模板生成?

Markdown#vs multiple#

我注意到,使用#或##或####是等价的…将永远如此吗? 我只想使用一个'#',因为它更方便,只要它在未来不会变得更大。 我不知道这是否适用于生成的文档,因为我不知道如何生成它,我只能找到命令行指令,但肯定必须有一个更简单的方法,从IDE我还没有找到。

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

在KDoc中,你可以这样做: /** * [Integer.equals] is an instance method. */ 但是你不能这样做: /** * [Integer.signum] is a static method. */ 通过“你不能”我的意思是说,IntelliJ IDEA不会引导你的静态成员的声明,如果你使用导航→宣言行动。 导航到静态字段也不起作用。 有没有办法链接到KDoc的Java类的静态成员? 这可能只是IDEA中的一个错误?

我如何继承KDoc文档?

在Java的Javadoc中,有一种方法可以使用{@inheritDoc}标记继承子类中的方法文档。 有没有办法在Kotlin的KDoc中做同样的事情? 基本上,我想要做的是以下几点: abstract class Base { /** * Some KDoc documentation here. */ abstract fun foo() } class Derived: Base() { /** * Here is all the documentation from Base#foo's KDoc inherited. * * And here goes something more in addition. */ override fun foo() { /* … */ } }

将多个源语言文档组合成一个Javadoc JAR

如果我有一个项目包含java , groovy代码和kotlin插件,并且每个代码都写有代码,那么我该如何创建一个包含所有代码文档的javadoc.jar发行版? java插件给了我javadoc类, groovy插件给了我groovydoc任务,但这些似乎没有合作。 我如何将这个文档合并成一个有凝聚力的工件?