AI辅助文档生成指南

项目说明、接口文档、代码注解轻松完成

程序员最头疼的就是撰写文档。然而缺少文档的项目，隔段时间连开发者自己都难以理解。

本文介绍利用AI产出三类文档的方法：项目说明、接口文档、代码注解。每种均提供提示词模板，直接套用即可。

· · ·

项目说明是工程的第一印象。让AI帮你输出一份完整的：

产出的项目说明常包含规范架构。你仅需调整几处细节：

💡窍门：让AI解析你的依赖配置文件，生成的项目说明更精准。

· · ·

接口文档最为繁琐。让AI遍历路由模块自动产出：

AI会分析代码生成结构化文档：

💡窍门：借助自动化工具批量执行更高效。一条命令即可完成。

· · ·

阅读他人未注解的代码十分折磨。让AI为整个源文件添加说明：

前后对比：

❌注解前： function calc(a, b) { return a * b * 0.85 }

✅注解后： // 得出折后总金额：单价 × 数量 × 八五折 function calc(a: number, b: number): number { return a * b * 0.85 }

💡窍门：附加“保持代码逻辑不变，仅增添注解”的限制，避免AI擅自修改源码。

· · ·

💡推荐收藏，往后撰写文档时直接套用提示词。

— — — — —

💬不想动手写文档？直接向我提问