주석 품질 검사기
코드 주석에서 시간이 지나면 낡아버릴 '변경 이력' 표현을 찾아내 현재의 불변식이나 설계 근거로 다시 쓰게 해주는 스킬.
개발·코딩중급★ 421⑂ 44AI 점수 9/10마지막 업데이트: 2026. 9. 20.
무엇을 해주나
- 지정한 파일의 주석만 스캔해 "now uses JWT", "fixed retry handling", "faster than before"처럼 과거 리비전을 전제로 하는 표현을 찾아냅니다.
- 후보 키워드 목록(
references/temporal-keywords.md)은 참고용일 뿐이며, 실제 주변 코드와 주석 문법을 확인한 뒤 판정합니다. 문자열 리터럴·식별자는 무시합니다. - 라이선스 헤더, 자동 생성 표식, API/버전 애너테이션, 아직 유효한 deprecation 안내는 보존합니다.
- 각 발견 건마다 함수 전체를 읽고 → 지속 가능한 사실(동작/근거)을 판단 → 다시 쓰거나 삭제 →
파일:줄번호, 원문, 수정안, 추론한 불변식을 보고합니다. - 의도가 불분명하면 함부로 근거를 지어내지 않고 그대로 두고 모호함만 보고합니다. 수정은 요청받았을 때만 적용합니다.
이런 분께 추천
- 오래된 코드베이스를 인계받아 주석과 실제 동작이 어긋나는지 점검해야 하는 개발자
- 코드 리뷰 체크리스트에 주석 품질을 포함하고 싶은 팀 리드
- 언어·스택에 관계없이 문서화·유지보수 부채를 줄이고 싶은 모든 개발자
활용 예시
src/auth/폴더 주석을 검토해줘 → "// now uses JWT instead of sessions"를 "// Tokens are JWTs signed with RS256; sessions are not used"로 재작성 제안.- PR 디프에 포함된 파일만 스캔해 시간 의존 주석 목록을
file:line형태로 뽑아 리뷰 코멘트에 붙이기. - "// fixed the race condition" 같은 주석에 대해, 주변 코드에서 근거를 확정할 수 없으면 수정하지 않고 '의도 불명확'으로 보고.
· · · 설치 가이드 · · ·
설치 없이 지금 한 번 써보기
아래를 Claude에 붙여넣으면 설치하지 않고도 이 스킬을 그대로 씁니다.
이 파일의 지시를 읽고 그대로 따라서 나를 도와줘: https://raw.githubusercontent.com/notque/vexjoy-agent/HEAD/skills/code-quality/comment-quality/SKILL.md 내가 원하는 것: (여기에 하고 싶은 일을 쓰세요)
Claude가 링크를 열지 못하면, 링크를 직접 열어 내용을 복사해 붙여넣으세요.
↓ 쓸 만하면 아래에서 ZIP을 받아 설치하세요. 그러면 매번 붙여넣지 않아도 알아서 작동합니다.
Claude 앱에 설치 (터미널 필요 없음)
- 아래 버튼으로 ZIP 파일을 받으세요.
- Claude 설정 → Capabilities에서 '코드 실행 및 파일 생성'을 켭니다. (한 번만)
- Claude에서 Customize → Skills → + → '스킬 업로드'를 누르고 받은 ZIP을 올립니다.
Claude Code에 설치
Claude에게 맡기기 — 아래 문장을 Claude Code에 붙여넣으세요
클로드스킬마트에서 찾은 스킬을 설치해줘. GitHub 저장소 notque/vexjoy-agent 의 skills/code-quality/comment-quality 폴더를 내 ~/.claude/skills/comment-quality/ 에 그대로 복사해줘. 설치가 끝나면 이 스킬로 무엇을 할 수 있는지 한 줄로 알려줘.
직접 명령으로 설치하기
git clone https://github.com/notque/vexjoy-agent.git /tmp/vexjoy-agent && mkdir -p ~/.claude/skills && cp -r /tmp/vexjoy-agent/skills/code-quality/comment-quality ~/.claude/skills/⚠ 제3자가 만든 스킬입니다. 설치 전 원본 저장소를 한 번 확인하세요.
- 터미널을 엽니다.
- 저장소를 내려받습니다:
git clone https://github.com/notque/vexjoy-agent.git - 스킬 폴더를 만듭니다:
mkdir -p ~/.claude/skills - 스킬을 복사합니다(참조 파일 폴더까지 함께):
cp -r vexjoy-agent/skills/code-quality/comment-quality ~/.claude/skills/ ~/.claude/skills/comment-quality/안에SKILL.md와references/temporal-keywords.md가 있는지 확인합니다.- Claude Code를 다시 시작한 뒤, "이 파일들의 주석 품질을 검토해줘"처럼 요청하면 라우팅됩니다. (이 스킬은
user-invocable: false라 직접 이름으로 부르기보다 리뷰 흐름 안에서 호출되도록 설계되어 있습니다.)
GitHub에서 원본 보기 ↗라이선스: MIT