工具介绍
核心功能
Stenography 面向代码说明和技术文档生成，帮助开发者为代码库、函数、接口或复杂逻辑生成解释内容。它适合把难读代码转成更容易交接和维护的文字说明，减少新人理解项目和团队补文档的阻力。
适合场景
开发者可以用 Stenography 解释遗留代码，API 维护者可以生成接口说明，工程团队也能在重构、交接或开源发布前补充技术文档。对快速变化的项目，自动生成初稿能帮助文档更接近代码当前状态。
使用边界
代码文档必须反映真实行为。Stenography 生成说明后，要对照代码、测试和运行结果核实，尤其是权限、异常处理、边界条件和性能约束。文档不能只描述看起来的意图，还要说明实际输入、输出和副作用。
如果文档要对外发布，还要统一术语、示例和版本号，避免误导 API 使用者。
常见问题
Stenography 主要生成什么？
它主要为代码、函数和接口生成解释说明和技术文档草稿。
Stenography 适合遗留项目吗？
适合帮助理解难读代码，但生成文档仍要由熟悉项目的人确认。
Stenography 输出后要检查什么？
要核对代码行为、异常条件、参数含义、返回值和安全边界。
