这条提示词适合 编程开发 / 文档撰写 / 文档 相关场景。你可以先看摘要理解用途，再按公式和完整提示词做改写。
行业领域
编程开发
提示词类型
文档撰写
适用场景
编程开发 / 文档撰写 / 文档
摘要说明
适用于“代码注释规范文档”场景的提示词模板。
提示词公式
编程语言 + 注释类型（文件注释/函数注释/行内注释）+ 注释格式 + 注释内容要求 + 示例代码 + 注意事项
完整提示词
撰写JavaScript代码注释规范文档，注释类型为文件注释（说明模块功能）、函数注释（说明函数功能+参数+返回值）、行内注释（解释复杂逻辑），注释格式为单行注释//、多行注释/* */，注释内容要求为文件注释包含作者、创建日期、功能说明；函数注释包含功能描述、参数类型和含义、返回值类型和含义；行内注释解释算法逻辑，示例代码含完整的注释样例，注意事项为注释需与代码同步更新、避免过时注释，要求规范清晰、可执行。
核心关键词
格式统一
内容简洁
注释到位
优化技巧
- 要求AI"注释示例需覆盖典型场景"（如函数有参数可选、有返回值复杂类型），避免遗漏；明确"注意事项需强调常见问题"（如"注释需与代码同步更新"），提升代码可维护性。
- ---