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

Jac*_*man 6 documentation package kotlin kdoc kotlin-dokka

在Java中,如果要记录包,则必须将其放入package-info.class文件中.对于Kotlin和KDoc来说,这仍然是一回事吗?我查看了一些Kotlin源代码,无法找到编写包文档的位置.

mfu*_*n26 5

您使用includeDokka配置选项.

请参阅:https://github.com/Kotlin/dokka/blob/master/README.md

示例:https://github.com/JetBrains/kotlin/blob/58e93d5e1bb547c8a7e398587b6851ccf6372326/libraries/build-docs.xml

  • 尽管package-info很糟糕,但我比手动告诉生成器包括某些文件要好得多。 (2认同)
  • @yole “每个包一个文件,就像 Java 中一样”有时是一种更理想的方法。在 Java/Javadoc 中,您有更多的自由,因为您可以创建一个“overview.html”页面(一个用于所有包),或单独的“package-info.java”(每个包),或两者都创建。 (2认同)