←

✨代码注释规范文档

办公提效文档处理文档整理规范命名

摘要说明

适用于“代码注释规范文档”场景的提示词模板。

提示词公式

编程语言 + 注释类型（文件注释/函数注释/行内注释）+ 注释格式 + 注释内容要求 + 示例代码 + 注意事项

完整提示词

ID 1758

撰写JavaScript代码注释规范文档，注释类型为文件注释（说明模块功能）、函数注释（说明函数功能+参数+返回值）、行内注释（解释复杂逻辑...

核心关键词

格式统一内容简洁注释到位

优化技巧

要求AI"注释示例需覆盖典型场景"（如函数有参数可选、有返回值复杂类型），避免遗漏
明确"注意事项需强调常见问题"（如"注释需与代码同步更新"），提升代码可维护性
---