AgentSkillsCN

review-comments

检查变更文件的注释是否与代码实际运行逻辑保持一致。

SKILL.md
--- frontmatter
name: review-comments
description: 변경된 파일의 주석이 코드 동작과 일치하는지 검토합니다.
allowed-tools: Read, Edit, Grep, Glob, Bash

주석 검토 실행

1단계: 변경된 파일 파악

다음 중 하나로 검토 대상 파일을 결정한다:

  • git diff --name-only로 변경된 파일 목록 확인
  • 사용자가 특정 파일을 지정한 경우 해당 파일만 대상

2단계: 파일별 주석 검토

각 파일에 대해 다음을 검사한다:

XML Summary (/// <summary>):

  • 클래스/시스템의 역할 설명이 실제 동작과 일치하는가
  • 새로 추가된 기능이 summary에 반영되었는가

인라인 주석 (//):

  • 주석이 코드 동작을 정확히 설명하는가
  • 변경된 로직에 대한 주석이 업데이트되었는가
  • 더 이상 존재하지 않는 동작을 설명하는 주석이 남아있지 않은가

삭제 대상 주석:

  • 실제 구현과 일치하지 않는 주석 → 삭제
  • 코드만으로 자명한 동작에 대한 주석 → 삭제
  • 삭제/변경된 로직을 설명하는 주석 → 삭제

3단계: 결과 보고 및 수정

검토 결과를 표로 정리한 뒤, 즉시 수정을 실행한다. 별도 사용자 확인을 기다리지 않는다.

파일위치조치이유
파일명라인 번호삭제 / 수정문제 설명

조치 원칙:

  • 구현과 불일치하는 주석은 수정이 아닌 삭제가 기본이다. 주석을 현재 구현에 맞게 고쳐 쓰는 것은 코드가 자명하지 않을 때만 한다.
  • XML Summary는 실제 동작에 맞게 수정한다.
  • 보고와 수정을 한 단계에서 처리한다.