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

在Java中，如果你想记录一个包，它必须放入package-info.class文件中。 Kotlin和KDoc仍然是一样的吗？我查看了一些Kotlin源代码，找不到它们的包文档在哪里编写。您在哪里/如何为Kotlin软件包添加文档？

2016-02-04 Jacob Zimmerman

https://kotlinlang.org/api/latest/jvm/stdlib/index.html似乎是从https://github.com/JetBrains产生/kotlin/blob/7105c7c182cc842bf4d970f9f3860aaefc2853ad/libraries/stdlib/src/Module.md，其中包含模块和软件包文档的标记。 – mfulton26

您使用include Dokka配置选项。

参见：https://github.com/Kotlin/dokka/blob/master/README.md

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

来源

2016-02-04 23:51:10 mfulton26

与包装信息一样糟糕，我喜欢它比手动告诉生成器包含某些文件更好。 –

Kotlin无法使用包信息方法，因为Kotlin中的包结构不需要与目录结构相匹配。通过Dokka，您可以拥有一个包含所有包的描述的文件，而不是像Java中的每个包一个文件。 – yole

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

回答

相关问题