원클릭으로
xml-comment-enrichment
XML 注释 AI 友好化刷新:分级策略补全 <summary>/<param>/<returns>/<example>/<remarks>。适用于核心库的公共 API 文档注释完善任务,提升 NuGet 包 XML 注释质量。
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
메뉴
XML 注释 AI 友好化刷新:分级策略补全 <summary>/<param>/<returns>/<example>/<remarks>。适用于核心库的公共 API 文档注释完善任务,提升 NuGet 包 XML 注释质量。
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
联网搜索 GitHub 等平台查找主流竞品,按功能维度制作对比矩阵表格,输出竞品分析报告。使用场景:新项目启动时需要了解行业竞品格局、用户说"竞品分析"/"对比竞品"/"行业调研"、竞品大版本发布后需要增量更新。
协议/通信/编解码/文件格式类项目的竞品交叉兼容测试:我写你读、你写我读、我写我读等多模式对比验证。使用场景:项目涉及文件格式读写、网络协议通信、音视频编解码等需要与竞品互操作验证的场景。
新建系统或模块的研发全流程:需求文档、功能清单、架构设计、竞品分析、迭代开发、自治批处理模式。适用于新建项目、需求整理、架构设计、功能拆分、任务分解、批量开发、自治模式等任务。包含标准文档模板。
A warm, generous consumer marketplace anchored on a clean white canvas and Airbnb Rausch (#ff385c), the single brand voltage that carries every primary CTA, search-button orb, and rating dot. Type run...
A sober, editorial workflow-software interface anchored on white canvas and dark-ink type, where brand voltage comes from full-bleed signature cards in coral, dark green, peach, and dark navy that pun...
A photography-first interface that turns marketing into a museum gallery. Edge-to-edge product tiles alternate light and dark canvases, framed by SF Pro Display headlines with negative letter-spacing ...
| name | xml-comment-enrichment |
| description | XML 注释 AI 友好化刷新:分级策略补全 <summary>/<param>/<returns>/<example>/<remarks>。适用于核心库的公共 API 文档注释完善任务,提升 NuGet 包 XML 注释质量。 |
| 目标 | 要求 | 产出 |
|---|---|---|
public 类/接口/委托 | <summary> + <remarks>(含适用/不适用场景) | 每类型至少一个 <example> |
public 方法(含参数) | <summary> + 每个参数 <param> + <returns> | 核心方法有 <example> |
public 属性 | <summary> + <value>(如非自描述) | — |
| 关键枚举 | <summary> + 每个成员逐行注释 | — |
| 目标 | 要求 | 产出 |
|---|---|---|
全部 public 类型 | <summary> 一句话定位 | 无 <example> |
全部 public 方法 | <summary> + <param>×N + <returns> | 无 <example> |
| 目标 | 要求 |
|---|---|
| 内部/私有成员 | 不动 |
明显的自描述方法(如 GetId()) | 保持原样 |
| 明显过时注释 | 仅删除明显错误的注释 |
/// <summary>根据订单编号获取订单信息</summary>
/// <param name="orderId">订单编号</param>
/// <returns>订单实体,未找到时返回 null</returns>
/// <remarks>
/// 此方法会查询数据库并缓存结果。适用于高频读取场景。
/// 不适用于需要实时一致性的场景(请改用 FindByKey)。
/// </remarks>
/// <example>
/// <code>
/// var order = OrderService.FindByOrderId("ORD20240101001");
/// if (order != null) Console.WriteLine(order.Status);
/// </code>
/// </example>
.csproj 确定目标框架和 public API 表面public 类型和方法,统计缺少注释的比率