Tag: javadoc

Kotlin – 接口方法引发的文档exception: 由于Kotlin没有得到检查exception，文档exception预期将被接口方法抛出的正确方法是什么？我应该在接口中还是在实现类中记录它（只有在具体方法实际抛出它时）？

我如何继承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任务，但这些似乎没有合作。我如何将这个文档合并成一个有凝聚力的工件？

Dokka – 跳过为默认的android包生成javadoc: 我正在尝试使用Dokka插件为Android Kotlin应用程序生成Javadoc。我把插件添加到我的gradle中： classpath "org.jetbrains.dokka:dokka-gradle-plugin:0.9.15" 然后我按照项目说明做了一个基本配置： dokka { outputFormat = 'javadoc' outputDirectory = "$rootDir/docs" skipEmptyPackages = true noStdlibLink = true } 我使用基本的gradle命令生成文档： [user@linux AppDir]$ bash gradlew dokka 输出是好的，但它包括从我已经添加到我的项目的android或插件的多个目录，例如： android.R android.support com.google com.crashlytics . . . etc. 我如何跳过这些包？有什么办法只为我的/ app / scr / java文件夹和我创建的文件生成码头吗？任何帮助表示赞赏。

Kotlin文档不支持“”这样的标签: 我正在写文档评论来描述一种方法。 /** * necessary * setType is to set the PendingIntend's request code */ 但它不会显示段落。如果我不使用 ，所有的文档都没有任何中断。它在Java类中工作，但是当涉及到Kotlin时，我不知道如何处理它。

在IntelliJ / Android Studio中使用Kotlin注释格式: 有没有一种方法来设置IntelliJ IDEA / Android Studio中的长Kotlin注释与Java注释时相同的方式：代码样式> Java> JavaDoc>包装在右边缘当你打开这个设置时，格式化后会变成这样： /** * This is my very very very long comment which probably should be multi-line…. */ 进入这个： /** * This is my very very very long comment * which probably should be multi-line… */ 我没有看到Kotlin的同样的选择，但也许有另一种方法来实现这一目标？