菜单
Reviews C# code comments for XML documentation completeness, clarity, consistency, and aviation/Mode-S domain-specific standards. Use when reviewing code quality, checking documentation, or ensuring comments explain intent rather than mechanics.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
| name | comment-reviewer |
| description | Reviews C# code comments for XML documentation completeness, clarity, consistency, and aviation/Mode-S domain-specific standards. Use when reviewing code quality, checking documentation, or ensuring comments explain intent rather than mechanics. |
| allowed-tools | Read, Grep, Glob |
Reviews code comments in the aeromux project to ensure high-quality, consistent, and accurate documentation.
Public APIs (classes, methods, properties) must have:
<summary> - One-line description of what it does<param> - For each parameter, what it represents<returns> - What the method returns (if non-void)<exception> - What exceptions can be thrown and when<remarks> - Additional details, usage notes, or important contextExample:
/// <summary>
/// Decodes Mode-S Extended Squitter airborne position messages.
/// </summary>
/// <param name="message">The 112-bit Extended Squitter message.</param>
/// <returns>Decoded position data, or null if CPR decoding fails.</returns>
/// <exception cref="ArgumentException">Thrown when message format is invalid.</exception>
/// <remarks>
/// Requires both even and odd CPR frames for global position decoding.
/// See ICAO Annex 10, Volume IV for CPR algorithm details.
/// </remarks>
public Position? DecodeAirbornePosition(byte[] message)
Good comments explain WHY, not WHAT:
❌ Bad (describes what code does):
// Loop through all aircraft
foreach (var aircraft in trackedAircraft)
✅ Good (explains intent/reasoning):
// Remove stale aircraft that haven't sent updates in 60 seconds
// to prevent memory buildup from aircraft that have landed
foreach (var aircraft in trackedAircraft)
Check for:
When documenting Mode-S and ADS-B message parsing:
Always include:
Example:
/// <summary>
/// Parses Extended Squitter Airborne Velocity message (DF 17, TC 19).
/// </summary>
/// <remarks>
/// Decodes ground speed, heading, and vertical rate per ICAO Annex 10 Vol IV.
/// Supports both ground speed (subtype 1-2) and airspeed (subtype 3-4) encoding.
/// </remarks>
Common terms to document:
Ensure:
Examples of consistency checks:
<exception> tagsWhen no specific files are mentioned, the review scope is limited to changed or newly added files relative to the main branch. Use git diff --name-only main and git status to determine which files to review.
When the user specifies files or directories explicitly, review those instead.
Simply ask me to review comments in any way:
Examples:
I will:
When I review, I'll categorize each finding by severity:
Issues Found (grouped by severity):
Summary:
See aviation-doc-standards.md for detailed Mode-S documentation examples and reference material.
This skill can only read files - it won't modify your code. After review, I can help you implement suggested changes if you approve them.