产品亮点
保存代码时自动生成文档
API 把代码转成易懂解释
整合 Stack Overflow 建议和相关文档
支持多种扩展
每月 250 次免费调用
你能用它做什么
- 在 VS Code 里用插件自动记录代码文档
- 用 API 给已有代码生成解释
- 查 Stack Overflow 建议而不用离开工具
怎么用
- 1 安装 Stenography 的编辑器插件
- 2 在编辑器中正常编写并保存代码
- 3 查看自动生成的文档记录
- 4 需要时调用 API 获取代码解释
- 5 按需查看官方 Notion 页面里的案例与扩展
适合谁使用
不想手动维护文档的开发者需要给老代码补解释的团队通过 API 集成文档能力的工具开发者
优点
- 保存即记录，几乎不增加额外操作
- 自带相关文档和建议，减少查资料切换
- 每月 250 次免费调用可先试用
局限
- 每月 250 次免费额度有限，超量需付费
- 生成文档的准确度受代码可读性影响
- 插件主要面向 VS Code，其他编辑器需看支持情况
Stenography 是什么
Stenography 是一款自动文档生成工具，官方说明它能够在保存代码时自动记录整个代码库。它还提供强大的 API，可以把代码转换为简单易懂的解释，并支持自定义。此外它整合了 Stack Overflow 建议和相关文档，不用另外打开搜索就能找到解决方案，同时支持各种扩展并强调隐私保护，每月提供 250 次免费调用。
你能用它做什么
- 保存代码的同时自动生成文档记录。
- 用 API 把已有代码转成易懂的解释。
- 直接查看整合进来的 Stack Overflow 建议和相关文档。
- 通过扩展按团队习惯定制用法。
适合谁使用
- 不想手动维护文档的开发者。
- 需要给老代码补解释的团队。
- 想通过 API 把文档能力集成进自己产品的开发者。
需要留意什么
每月 250 次免费调用是上限，超量后需要付费，具体价格以官网计费为准。生成文档的准确度受代码本身可读性影响，命名混乱、逻辑绕的代码，解释质量也会打折扣。插件主要在 Visual Studio Code 场景中提到，其他编辑器的支持情况要查看官方文档确认。
常见问题
免费额度是多少？
官方说明每月提供 250 次免费调用。
支持哪些编辑器？
使用场景中提到 Visual Studio Code 插件，其他编辑器支持情况建议查看官方文档。
代码会被上传吗？
官方提到隐私保护，并把它列为产品特性之一。敏感代码建议先阅读官方隐私说明再决定。
为什么说它免费
官网写明的免费方式： 免费
免费额度、试用天数与功能范围由官网决定，随时可能调整，请以官网为准。
产品截图
截图归档自收录页面，仅供预览参考。
