SuperAPI AI 工具集

code-annotation-patterns

通用与其它

查看项目

更新于 10-16 03:37

技能介绍

用途:为代码添加结构化元数据、标签与标记,使 AI 辅助开发工具更易理解代码意图、风险与上下文。

主要能力:提供多种注解类别,包括技术债标记(@ai-tech-debt,含严重度 Critical/High/Medium/Low)、安全注解(@ai-security,含 @risk-level、@cwe、@mitigation)、性能注解(@ai-performance,含 @complexity、@bottleneck)、无障碍注解(@ai-a11y,含 @wcag-level)、测试注解(@ai-testing,含 @coverage、@missing-tests);以及语义标签,如变更影响(@ai-change-impact)、依赖(@ai-dependency)、配置(@ai-config)。

使用方式:以注释形式嵌入代码,可用内联注解、块注解或结构化元数据(JSON)。工具集成方面,资料给出用 ripgrep 提取注解的示例,如 rg "@ai-\w+" --type ts --json | jq '.text'、rg "@ai-security" -A 10、rg "@bottleneck: true" --type java;也可编写自定义 ESLint 规则强制注解规范,或用 Python 脚本提取 @ai-* 注解生成文档。

适用场景:AI 辅助开发中需要传递复杂上下文时,如标记重构目标、记录安全风险与缓解措施、标注性能瓶颈与优化方向、说明测试缺口、声明外部依赖失败模式与降级策略。

限制与最佳实践:资料强调应保持格式一致、信息完整、及时更新;避免过度注解显而易见代码、用注解代替修复代码或标签命名不一致。未提供具体安装命令、收费方式或平台信息。