ln-613-code-comments-auditor

仓库创建 2025年10月24日最近提交 3 天前SkillHot 收录 21 天前

▸ 精选理由

帮团队把注释从 WHAT 转为 WHY，提高可维护性。

▸ 风险提示

需要读取代码文件；对私有信息敏感。

这个 Skill 做什么

审查代码内联注释与 docstring 的质量与有效性。

用来审查代码里的内联注释和 docstring，着重看有没有讲为什么（WHY）而不是只说是什么（WHAT）、注释密度是否合适、是否包含禁用内容，以及是否过时或遗留垃圾。会按照语言特性检查 docstring 质量并给出清理和改进建议，适合把关注释可维护性和合规性。

▸ 展开 SKILL.md 英文原文

Checks inline code documentation quality: WHY-not-WHAT, density, forbidden content, docstrings quality, actuality, legacy cleanup. Use when auditing comments and docstrings.

开发编程注释审计docstring可维护性通用

522

Stars

Forks

仓库内 Skill

+10

7 日增星

安装 / 使用

给你的 Agent 一句话（通用）

帮我安装这个 skill：https://raw.githubusercontent.com/levnikolaevich/claude-code-skills/master/plugins/codebase-audit-suite/skills/ln-613-code-comments-auditor/SKILL.md

或 curl 直取 SKILL.md

curl -fsSL "https://raw.githubusercontent.com/levnikolaevich/claude-code-skills/master/plugins/codebase-audit-suite/skills/ln-613-code-comments-auditor/SKILL.md"

SKILL.MD 节选查看完整文件 ↗

> **Paths:** File paths (`references/`, `../ln-*`) are relative to this skill directory.

# Inline Code Documentation Auditor (L3 Worker)

**Type:** L3 Worker

Specialized worker auditing inline code documentation quality: comments, docstrings, and language-specific documentation blocks.

## Purpose & Scope

- Audit inline code documentation for **quality and compliance** across 6 categories
- Universal for any tech stack (auto-detect comment syntax)
- Return structured findings to coordinator with severity, location, recommendations
- Calculate compliance score (X/10) for Inline Code Documentation category
- Scope is limited to comments/docstrings/JSDoc/XML docs
- Out of scope: code design

via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有