目录 / do-code-comments
SKILL
未评级
已上架
do-code-comments
编写高信息量的代码注释,适用于人类开发者和编码智能体。在添加行内注释、文档字符串、API 注释或代码附近的局部逻辑说明时使用。触发场景包括:“写出更好的注释”、“为此添加注释”、“说明原因”、“对智能体友好的注释”、“用注释解释这段代码”、“编写文档字符串”。 - 明确说明“为什么”而非“做什么”(代码本身已体现行为)。 - 指出潜在陷阱、边界条件或设计取舍。 - 使用简洁、准确的语言,避免冗余。 - 为 API 提供清晰的参数、返回值及异常说明。 - 在复杂逻辑处标注上下文或业务规则来源。 - 保持注释与代码同步更新,避免误导。
模型生成摘要(rules/v1 · 2026-11-15 20:36):编写高信息量的代码注释,适用于人类开发者和编码智能体
这是模型对公开材料的总结,不是官方声明,请以原链内容为准。
这是模型对公开材料的总结,不是官方声明,请以原链内容为准。
存档时间线
| 版本 | 存档时间 | 内容哈希 | 内容 |
|---|---|---|---|
| v1 | 2026-11-15 20:35 | 0bc88527 | 可取 |
版本索引永久保留;内容副本只保留最新 1 份,更早版本仅留索引与哈希(存档时间线的证据链不会因此断裂)。
纠错与举报(发现条目失效、署名有误或涉及侵权?)
提交举报 / 纠错
侵权举报经核验成立后,我们会即时下线该条目并删除已存的内容副本。