kdoc-standards

KDoc 和代码注释规范：哪些内容需要文档化，哪些不需要；KDoc 标签的使用；公共 API 契约的编写方式；“为何”类注释（而非“如何”）；TODO/FIXME 的标注规范；Swift 端对应的 DocC 实践；以及 Dokka 文档生成。触发关键词包括：“写 KDoc”、“添加文档注释”、“解释此函数”、“javadoc”、“添加代码注释”、“为公共 API 编写文档”、“Dokka”、“注释规范”、“留下 TODO”。

模型生成摘要（rules/v1 · 2026-11-13 11:13）：KDoc 和代码注释规范：哪些内容需要文档化，哪些不需要；KDoc 标签的使用；公共 API 契约的编写方式；“为何”类注释（而非“如何”）；TODO/FIXME 的标注规范；Swift 端对应的 DocC 实践；以及 Dokka 文档生成
这是模型对公开材料的总结，不是官方声明，请以原链内容为准。

存档时间线

版本	存档时间	内容哈希	内容
v1	2026-11-13 11:13	42f7b577	可取

版本索引永久保留；内容副本只保留最新 1 份，更早版本仅留索引与哈希（存档时间线的证据链不会因此断裂）。

下载存档内容副本

纠错与举报（发现条目失效、署名有误或涉及侵权？）

提交举报 / 纠错

侵权举报经核验成立后，我们会即时下线该条目并删除已存的内容副本。