Skills
.Work. You
Rest

ln-610-code-comments-auditor

Community

Audit code comments for quality and clarity.

Software Engineering#code quality#maintainability#code comments#auditing#docstrings#legacy code
Authorcbbkrd-tech
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill addresses the common issue of poor-quality, unhelpful, or outdated code comments and docstrings, which can lead to confusion, maintenance difficulties, and bugs.

Core Features & Use Cases

  • Comprehensive Audit: Analyzes comments and docstrings across six critical categories: WHY-not-WHAT, Density, Forbidden Content, Docstrings Quality, Actuality, and Legacy Cleanup.
  • Scoring & Findings: Provides a compliance score per category and detailed findings with recommended actions.
  • Universal Applicability: Works with any programming language by auto-detecting comment syntax.
  • Use Case: After a major refactoring effort, use this Skill to ensure all new and existing code comments accurately reflect the current state of the codebase and adhere to best practices.

Quick Start

Run the code comments auditor skill on the current project directory.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: ln-610-code-comments-auditor
Download link: https://github.com/cbbkrd-tech/jl-finishes/archive/main.zip#ln-610-code-comments-auditor

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.