doc
starsforks
How to install doc?
lightpointventures/claude-code-starter/doc
$npx -y skills add lightpointventures/claude-code-starter --skill doc当用户想加文档注释、写 docstring、给代码加说明时使用 — 自动生成文档注释，风格与项目一致
SKILL.md
| 1 | # 生成文档 |
| 2 | |
| 3 | 为代码自动添加文档注释，省去手写文档的麻烦。 |
| 4 | |
| 5 | ## 步骤 |
| 6 | |
| 7 | ### 1. 确定文档目标 |
| 8 | |
| 9 | 如果用户指定了文件或函数，直接读取。 |
| 10 | |
| 11 | 如果没有指定，问： |
| 12 | > 你想给哪段代码加文档？可以告诉我文件名、函数名或类名。 |
| 13 | |
| 14 | ### 2. 检查项目的文档风格 |
| 15 | |
| 16 | 查看项目中已有的文档注释，了解： |
| 17 | - 使用的文档格式（Python: Google style / NumPy style / reStructuredText，JS/TS: JSDoc，Go: godoc） |
| 18 | - 文档语言（中文还是英文） |
| 19 | - 详细程度 |
| 20 | |
| 21 | 如果项目没有已有文档，根据语言社区惯例选择最常用的格式。 |
| 22 | |
| 23 | ### 3. 生成文档 |
| 24 | |
| 25 | 为目标代码生成文档注释，包括： |
| 26 | |
| 27 | - **简要描述** — 一句话说明这个函数/类做什么 |
| 28 | - **参数说明** — 每个参数的名称、类型、含义 |
| 29 | - **返回值** — 返回什么、什么类型 |
| 30 | - **异常/错误** — 可能抛出什么异常（如果有） |
| 31 | - **使用示例** — 一个最简单的调用示例（仅对复杂函数添加） |
| 32 | |
| 33 | 规则： |
| 34 | - 文档要准确反映代码实际行为，不要写代码没做的事情 |
| 35 | - 保持简洁，不要把显而易见的事情写进文档 |
| 36 | - 与项目已有的文档风格保持一致 |
| 37 | |
| 38 | ### 4. 写入 |
| 39 | |
| 40 | 展示生成的文档，询问用户： |
| 41 | > 文档生成好了，要我写入文件吗？ |
| 42 | |
| 43 | 用户确认后写入。 |
People who liked this also viewed
6 picksType
- grill-with-docsA relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.SkillsJul 2026
- lark-minutes飞书妙记：搜索妙记、查看妙记基础信息、下载/上传音视频、读取或编辑妙记的产物内容、改标题、替换说话人/关键词、申请妙记查看/编辑权限。当给出minute_token、本地音视频文件，要查/改/转妙记产物，或用户明确要主动申请妙记权限时使用；本地音视频转纪要/逐字稿优先走本 skill，不要用 ffmpeg/whisper 本地转写。不负责：获取会议关联妙记，或仅按自然语言标题定位纪要SkillsJul 2026
- lark-markdown飞书 Markdown：查看、创建、上传、编辑和比较 Markdown 文件。当用户需要创建或编辑 Markdown 文件、读取、修改、局部 patch 或比较差异时使用。不负责将 Markdown 导入为飞书在线文档，也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。SkillsJul 2026
- docxUse this skill whenever the user wants to create, read, edit, or manipulate Word documents (.docx files) or Word templates (.dotx files). Triggers include: any mention of 'Word doc', 'word document', SkillsJul 2026
- edit-articleSkills for Real Engineers. Straight from my .agents directory.SkillsJul 2026
- lark-note飞书会议纪要（Note）直查：已知 note_id 时查询纪要详情、展示类型、关联文档 token，并读取 unified 原始逐字记录。当用户已持有 note_id，或从文档显式 vc-node-id 获得 note_id 时使用。不负责会议/日程/妙记定位、文档标题搜索或 Docx 正文读取。SkillsJul 2026
