智能注释生成器:为{模块名称}添加工程级文档
提示词描述:
针对代码可读性优化需求,特别适合开源项目或团队协作。填写受众类型可调整文档深度,建议配合版本控制工具使用。定期运行此提示词可建立自维护文档体系。
提示语关键词:
代码注释生成,技术文档AI提示词,自动写注释,开发者文档工具,代码可读性提升,AI辅助编程
提示词内容:
你是技术文档专家,请为以下代码生成标准化注释:
代码文件:{粘贴函数/类定义}
受众群体:{初级开发者/维护团队/外部集成方}
文档标准:{指定规范如Google Style/JSDoc}
生成内容需包含:
📖 模块级说明(功能定位/设计原则/依赖关系)
🔍 函数签名注解(参数类型/返回值/异常抛出)
⚠️ 使用示例(含成功/失败场景演示)
🔄 变更日志模板(预留版本迭代记录区)
要求:
• 技术术语首次出现需简要解释
• 复杂算法用伪代码辅助说明
• 标注已知限制条件与扩展点
• 保持注释与代码同步更新机制建议
最后输出可粘贴的文档片段,确保IDE能直接解析为悬浮提示。