kotlin - 在哪里放置 Kotlin 文件的文档(不是包,不是模块,不是类)
问题描述
我应该在哪里评论 Kotlin 源文件?
类和其他对象有 KDoc:
/**
* Summary
*
* Rest of documentation goes here.
*/
class A {
...
}
但是我应该把这样的东西放在哪里?
// This file contains constants shared between frontend and backend.
// Make sure not to use any JVM- or JS-specific import.
// ...
package
申报前?之后呢?我应该使用 KDoc 注释/块注释/行注释吗?
有没有既定的约定?
解决方案
文件不是 API 的一部分,因此没有地方可以放置文件的文档以便 Dokka 选择它。您应该对此类文档使用常规(而不是 KDoc)注释,并将其放在便于人类读者查找的位置(很可能在导入块之后),因为机器对这些信息没有用处。
推荐阅读
- javascript - 如何在我的 innerHTML 按钮标签中引用 HTML 集合的索引号?
- c - 访问在另一个 c 文件中定义的结构?
- c# - 关于DataTable的动态列表和TypeDescriptor的使用
- java - 我如何获取 Gps 位置并使用短信作为谷歌地图链接发送
- javascript - 使用 WordPress 将 alt 标签作为标题添加到 Photoswipe 画廊
- angular - 解决 Angular 9 中强制性的、不可避免的循环依赖问题
- vba - VBA 在 SAP GUI 中打开新会话并在其中执行事务
- docker - 如何修复springboot错误无法检索RMIServer存根:JRMP连接建立期间javax.naming.CommunicationException错误
- python - 使用 Manim 导入模块
- forms - 使用 Vue 为具有多个按钮的表单调用不同的方法