SuperAPI AI 工具集

document-code

写作与研究

查看项目

更新于 10-15 08:08

技能介绍

用途

Document Code 是一个代码文档生成技能,用于为代码库产出各类文档。根据资料,其覆盖的文档形式包括:行内注释、函数/方法 docstring、模块/文件头、模块或服务的 README、API 文档、架构文档、更新日志(changelog)与迁移指南(migration guides)。技能的核心主张是:好的文档解释 WHY(意图、背景、取舍、坑点),而不只是重复 WHAT,因为代码本身已经展示了它做什么。

主要能力

  1. 文档写作流程:在动笔前要求读懂代码的完整上下文、识别受众(新成员、API 使用者、未来维护者还是自己)、检查既有文档避免重复或矛盾、理解该代码在整体架构中的位置。
  2. 文档类型选择:资料给出了一张“类型—使用时机”对应表,用于判断该写哪种文档。
  3. 行内注释规范:明确“何时该注释”与“何时不该注释”。
  4. 函数与方法文档:要求每个公开函数记录功能一句话概要、参数(名称、类型、描述、约束、默认值)、返回值、可能抛出的错误、示例与副作用(数据库写入、API 调用、文件改动、事件发出)。
  5. 多语言 docstring 格式:给出 TypeScript/JavaScript(TSDoc/JSDoc)、Python(Google Style)、Go(Godoc)、Java(Javadoc)、Ruby(YARD)、PHP(PHPDoc)、Rust(Rustdoc)、Swift、Kotlin(KDoc)的示例写法,示例中均包含参数、返回值、异常、示例、since 等要素。
  6. 模块与文件头:每个非显而易见的文件应写头部说明,内容包括模块职责、关键流程、关键决策、依赖项等。
  7. README 生成:给出 README 的结构模板,含模块/服务名称、一句话描述、Overview、Getting Started(Prerequisites、Installation、Running Locally)、Architecture 等章节。

使用方式

按资料描述,这是一个技能(Skill),在需要为代码生成文档时按其结构化流程执行:

  1. 先理解代码再写文档;
  2. 判断需要哪类文档;
  3. 按对应语言的 docstring 规范书写;
  4. 对非显然文件补模块头,对模块/服务补 README。

关于具体的安装命令、调用方式与集成步骤,资料中暂未提供。

行内注释的取舍

资料明确了注释的适用场景:复杂算法(解释思路而非逐行)、变通与 hack(说明原因并附 issue/工单链接)、非显而易见的业务规则(解释领域逻辑)、性能取舍(解释为何选择可读性较差的做法)、正则表达式(始终解释匹配内容)、魔法数字(说明来源)。同时也明确了不应做的事:不复述代码已表达的内容、不逐行注释、不保留被注释掉的代码(应交给版本控制)、不写没有工单号的 TODO。资料还给出了“坏注释 vs 好注释”的对照示例,例如把 // Set age to 18 改为说明 COPPA 合规要求的最小年龄常量,以及为 Safari flex gap 兼容问题写 HACK 注释并附 WebKit bug 链接。

适用场景

  • 为公开函数、方法与类补充 docstring;
  • 为模块、包或服务撰写 README;
  • 为 API 端点编写面向调用方的文档;
  • 整理系统设计、数据流与组件关系的架构文档;
  • 记录版本间的变更与破坏性变更的迁移指南;
  • 在复杂逻辑、变通方案、正则与魔法数字处补充行内注释。

限制

  • 资料未提供收费、价格、平台支持范围、效果承诺或性能数据,这些暂未提供。
  • 资料未提供安装命令与具体调用步骤,暂未提供。
  • 资料中的示例为演示性质,实际内容需依据被文档化的代码本身确定。