AST 提参数类型和默认值，比纯文本注释准在哪：三种生成函数文档方式的对比
AST 提取签名信息配合注释解析是生成准确 API 文档的最优方案：类型和默认值从 AST 直接获取，准确率 100%，描述文字从 docstring 匹配。纯文本正则解析在处理复杂默认值时准确率骤降，纯 AST 生成则缺少描述信息。推荐使用 `ast` 模块加 `docstring_parser` 库实现，约 100-150 行代码即可稳定运行。
标签: #接口文档生成
共 3 篇文章
把错误码表和业务规则喂给模型后，错误场景说明怎么从“失败”变成能直接用的排查步骤
错误场景说明质量差，根源在于上下文缺少排查路径维度。将错误码表升级为包含触发条件、可观测信号、检查动作、修复动作和验证方式的诊断卡片，并在提示词中明确要求按顺序完整输出排查步骤，禁止省略或推给客服。诊断卡片应作为 YAML 源数据维护在版本库，通过 CI 自动生成文档，确保单一数据源和同步更新。
接手屎山代码时，我让 AI 把接口逻辑和业务语义自动填进了文档
接手无文档老项目时，用AI按接口分析调用链并自动生成业务语义文档，效率极高。核心流程分四步：先让AI扫描项目结构建立全局认知；再逐接口追踪完整调用链，区分代码含义与业务含义；接着通过多轮对话补全业务场景和规则；最后格式化输出可直接交付的接口文档。该方法比人工编写更可靠、高效，37个接口仅需40分钟，但依赖清晰的代码结构和主流框架。