with one click
doc
当用户想加文档注释、写 docstring、给代码加说明时使用 — 自动生成文档注释,风格与项目一致
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Menu
当用户想加文档注释、写 docstring、给代码加说明时使用 — 自动生成文档注释,风格与项目一致
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
当用户踩坑后想记录经验教训、当调试完想防止同样的问题再次发生、当做了重要技术决策想记录时使用 — 自动更新 CLAUDE.md 的已知陷阱和决策日志
当用户首次使用模板、想配置项目信息、需要填写 CLAUDE.md 占位符时使用 — 通过问答自动填写项目信息
当用户想检查无障碍性、添加 ARIA 标签、修复键盘导航或对比度问题时使用 — 检查并修复网站无障碍性问题
当用户想写接口、创建 API、生成后端端点、做增删改查接口时使用 — 生成 RESTful API 端点,包含路由、验证和错误处理
当用户想加登录、注册、用户认证、OAuth、JWT、权限控制时使用 — 为项目添加完整的用户认证系统
当用户想搭建博客、做个人网站、写技术文章、建内容站时使用 — 从零生成完整的博客网站
| name | doc |
| description | 当用户想加文档注释、写 docstring、给代码加说明时使用 — 自动生成文档注释,风格与项目一致 |
为代码自动添加文档注释,省去手写文档的麻烦。
如果用户指定了文件或函数,直接读取。
如果没有指定,问:
你想给哪段代码加文档?可以告诉我文件名、函数名或类名。
查看项目中已有的文档注释,了解:
如果项目没有已有文档,根据语言社区惯例选择最常用的格式。
为目标代码生成文档注释,包括:
规则:
展示生成的文档,询问用户:
文档生成好了,要我写入文件吗?
用户确认后写入。