告别手动写文档!AI自动生成代码注释

官方 5 查看 0 有趣 0 复制 0 收藏

提示词描述:

适用于需要规范项目文档的开发团队,尤其适合多人协作场景。通过AI生成标准化注释模板,降低文档维护成本。建议提供代码仓库结构和团队规范文档,可获得更贴合实际需求的输出。

提示语关键词:
代码注释生成,API文档自动化,ChatGPT写注释,TypeScript开发工具,技术文档模板,编程规范工具
提示词内容:
作为技术文档专家,请按以下规范为我的TypeScript项目生成标准化注释。 首先,请分析代码结构并识别需要注释的组件:1. 公共API接口 2. 复杂算法实现 3. 状态管理逻辑。其次,采用JSDoc格式生成包含@description、@param、@returns的标准注释块,特殊业务逻辑需添加@example代码示例。 注意事项:保持注释与代码同步更新机制,提供注释覆盖率检测脚本。对于遗留代码,请区分必需注释和可选注释等级。输出时附带注释规范检查清单,包含命名约定、示例格式和更新频率建议。 现在开始文档生成,请逐文件处理并标记进度。遇到模糊逻辑时,请主动询问业务上下文。记住清晰的注释是团队协作的基石,让我们共同建立可维护的代码库!完成后请提供自动化注释更新方案。
返回列表

提示词排行榜

文章排行榜