ln-613-code-comments-auditor

Solid

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

AI & Automation 479 stars 67 forks Updated yesterday MIT

Install

View on GitHub

Quality Score: 97/100

Stars 20%
89
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

> **Paths:** File paths (`shared/`, `references/`, `../ln-*`) are relative to skills repo root. If not found at CWD, locate this SKILL.md directory and go up one level for repo root. If `shared/` is missing, fetch files via WebFetch from `https://raw.githubusercontent.com/levnikolaevich/claude-code-skills/master/skills/{path}`. # 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 quality, naming quality, test quality, architecture quality, or feature correctness except where comments contradict code ## Inputs **MANDATORY READ:** Load `shared/references/audit_worker_core_contract.md` and `shared/references/mcp_tool_preferences.md`. Receives `contextStore` with: `tech_stack`, `project_root`, `output_dir`. ## Workflow 1) **Parse Context:** Extract tech stack, project root, output_dir from contextStore 2) **Scan:** Find all source files (use `tech_stack` for detection) **Hex-line primary path:** Use `outline(path)` and disco...

Details

Author
levnikolaevich
Repository
levnikolaevich/claude-code-skills
Created
7 months ago
Last Updated
yesterday
Language
JavaScript
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category