ql-link/linkrag/code-annotator
Claude Code and agent skill by ql-link/linkrag
Trust tier 3
- community
Source check pending
Checking that the SKILL.md file is still in the repository.
代码高质量注释生成工作流。为 Python 项目生成恰到好处的 Docstring 注释,强调全局上下文感知、注释粒度控制和 PEP 257 规范。
Install
npx vskill@latest install ql-link/linkrag/code-annotatorSKILL.md
代码高质量注释生成规范
描述
资深后端架构师与文档专家,精通 Python Docstring 规范。能够结合文件的本地逻辑以及它在项目中的全局上下文,生成恰到好处的代码注释。既不遗漏关键业务解释,也不浪费笔墨注释显而易见的代码。
核心原则
拒绝废话 - 不要对显而易见的代码进行翻译式注释。
count = 0 # 初始化计数器→ 废话user.name = name # 设置用户名→ 废话
注释分层要求
类注释(必须)
说明核心业务职责、设计意图、架构位置。
方法/函数注释(必须)
说明业务目的、入参含义、返回值、可能抛出的异常。
内部注释(按需严格限制)
必须注释的场景:
- 复杂的核心算法步骤
- 状态流转逻辑
- 跨模块/中间件调用:必须说明"为什么要调用"以及"预期的业务结果"
禁止注释的场景:
- 简单的赋值操作
- 变量声明与基础判空
- 显而易见的流程控制
文件角色识别
在生成注释前,分析文件在架构中的位置:
- API/Router: FastAPI Router、Flask Blueprint
- Service: 聚合业务逻辑层,编排多个 Repository
- Repository: 数据访问层,DAO、ORM 操作类
- Model/Schema: Pydantic Schema、SQLAlchemy Model
- Middleware: 依赖注入、中间件
- Util: 工具类
Docstring 规范 (Google Style)
类注释
方法/函数注释
内部注释风格
工作流程
- 接收输入:获取用户指定的目标文件/文件夹路径
- 扫描依赖:提取
import的核心依赖,分析外部模块的业务作用 - 上下文分析:理解该文件在架构中的位置(API/Service/Repository/Model/Util)
- 生成注释:按分层要求生成恰到好处的注释
- 输出结果:保持原有代码的缩进和结构,只补充或优化注释
约束条件
- 不改变逻辑:只负责补充或优化注释,不改变现有业务逻辑
- 保持缩进:输出时保持原有代码的缩进和结构
- 信息密度:注释应具有信息增量,而非简单翻译代码
- 业务导向:注释应解释"为什么",而非"做了什么"
使用示例
示例取自本项目领域(RAG 解析/向量化),不要用与项目无关的样例(如用户注册)。
用户输入
为稀疏向量编码器 http_encoder.py 生成注释
Agent 响应
上下文分析
- 文件角色:Core 模块(稀疏向量编码器,实现
SparseVectorEncoderProtocol) - 外部依赖:远程
bge-m3-server(HTTP)、httpx - 调用关系:由
sparse_vector/factory.py按SPARSE_VECTOR_PROVIDER=bge_m3_http装配,供SparseVectorService调用
输出带注释的代码:
Security
- Security scanPassed, 90 of 100Pattern checks on the skill's files.
- Model reviewPassed
Quality evaluation
- Task evaluationNot runNo evaluation yet. Run one in Skill Studio.
Source
- SKILL.md in the repositoryChecking.ai/skills/code-annotator/SKILL.md
Popularity
- 7-day trend score
- 0
Not refreshed yet.
Works with
Any agent vskill installs to: 56 targets in all. These 39 have a page on this site.
- Claude Code
- Cursor
- GitHub Copilot
- Windsurf
- Codex
- Gemini CLI
- Cline
- Amp
- Roo Code
- Goose
- Continue
- Kilo Code
- Junie
- Trae
- OpenHands
- Qwen Code
- AI Agent
- Tabnine Chat
- Sourcegraph Cody
- Amazon Q
- Firebase Genkit
- Sweep
- Devin
- Phind
- Mentat
- Claude Desktop
- Aider
- GPT Pilot
- Plandex
- bolt.new
- v0
- Replit Agent
- Anse
- TypingMind
- BetterChatGPT
- LibreChat
- Warp AI
- Pieces
- Fig AI
Embed badge
[](https://verified-skill.com/skills/ql-link/linkrag/code-annotator)