Doc
当用户想加文档注释、写 docstring、给代码加说明时使用 — 自动生成文档注释，风格与项目一致
Install
$ agentstack add skill-lightpointventures-claude-code-starter-doc ✓ scanned · ✓ verified, works with Claude Code, Cursor, and more.
Security review
✓ PassedNo issues found. Passed automated security review. · v0.1.0 How review works →
- ✓ Prompt-injection patterns
- ✓ Secret / credential exfiltration
- ✓ Dangerous shell & filesystem operations
- ✓ Untrusted network calls
- ✓ Known-malicious package signatures
What it can access
- ✓ Network access No
- ✓ Filesystem access No
- ✓ Shell / process execution No
- ✓ Environment & secrets No
- ✓ Dynamic code execution No
From automated source analysis of v0.1.0. “Used” means the capability is present in the source — more access means more to trust, not that it’s unsafe.
Verified badge
Passed review? Show it. Paste this badge into your README, it links to the public security report.
Links to your public security report.[](https://agentstack.voostack.com/security/report/skill-lightpointventures-claude-code-starter-doc) Reliability & compatibility
Declared compatibility
Compatibility is declared by the source manifest. End-to-end runtime verification is coming, see below.
We're building live execution health for every listing: tool-call success rate, median latency, uptime, and last-checked timestamps, measured, not self-reported. It isn't live yet, so we don't show numbers we can't stand behind.
How agent discovery & health will work →About
生成文档
为代码自动添加文档注释，省去手写文档的麻烦。
步骤
1. 确定文档目标
如果用户指定了文件或函数，直接读取。
如果没有指定，问： > 你想给哪段代码加文档？可以告诉我文件名、函数名或类名。
2. 检查项目的文档风格
查看项目中已有的文档注释，了解：
- 使用的文档格式（Python: Google style / NumPy style / reStructuredText，JS/TS: JSDoc，Go: godoc）
- 文档语言（中文还是英文）
- 详细程度
如果项目没有已有文档，根据语言社区惯例选择最常用的格式。
3. 生成文档
为目标代码生成文档注释，包括：
- 简要描述 — 一句话说明这个函数/类做什么
- 参数说明 — 每个参数的名称、类型、含义
- 返回值 — 返回什么、什么类型
- 异常/错误 — 可能抛出什么异常（如果有）
- 使用示例 — 一个最简单的调用示例（仅对复杂函数添加）
规则：
- 文档要准确反映代码实际行为，不要写代码没做的事情
- 保持简洁，不要把显而易见的事情写进文档
- 与项目已有的文档风格保持一致
4. 写入
展示生成的文档，询问用户： > 文档生成好了，要我写入文件吗？
用户确认后写入。
Source & license
This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.
- Author: lightpointventures
- Source: lightpointventures/claude-code-starter
- License: MIT
- Homepage: https://github.com/lighthouse-strategy/claude-code-starter
Install and usage instructions live in the source repository linked above.
Reviews
No reviews yet, be the first.
Write a review
Versions
- v0.1.0 Imported from the upstream source.