Global Commenting

Apply centralized global commenting standards to code files and modules.

1|Updated Sep 15, 2024
One-click install
npx skills add https://github.com/Software-Design-Club/todo-app --skill global-commenting-software-design-club
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Global Commenting
Source: https://github.com/Software-Design-Club/todo-app/tree/main/.claude/skills/global-commenting
Command: npx skills add https://github.com/Software-Design-Club/todo-app --skill global-commenting-software-design-club

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill standardizes code commenting across your entire codebase, improving readability and maintainability without requiring tedious manual effort.

Core Features & Use Cases

  • Automated Commenting: Applies consistent commenting styles (e.g., JSDoc, Python docstrings) to new or existing code.
  • Documentation Enforcement: Ensures all critical code sections, functions, and classes are adequately documented.
  • Use Case: Automatically review and add missing comments to a newly written Python module, ensuring all functions and classes have comprehensive docstrings.

Quick Start

Use the global commenting skill to add appropriate comments to the 'utils.js' file, explaining complex logic and function parameters.

Frequently Asked Questions about Global Commenting

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce consistent commenting standards across my codebase?

Enforce consistent commenting standards by applying global commenting guidelines automatically across files and modules. This Skill implements centralized rules for comment syntax, tags, and documentation blocks, ensuring all code follows the same style without manual effort.

Can I automatically add missing comments to functions and classes?

Yes. This Skill automatically reviews code and adds missing comments to functions, classes, and critical sections using language-appropriate formats like JSDoc or Python docstrings, ensuring comprehensive documentation across your project.

What commenting styles does this support across different languages?

This Skill applies consistent commenting styles across languages and project contexts—including JSDoc for JavaScript, docstrings for Python, and other language-specific formats—all conforming to your centralized global commenting guidelines.

How does automated commenting improve code readability and maintainability?

Automated commenting standardizes documentation blocks, function parameters, and inline explanations across your codebase. Consistent, comprehensive comments reduce confusion, accelerate onboarding, and make complex logic easier to understand without manual documentation work.

Does this Skill work with existing code or only new files?

This Skill works with both new and existing code. It reviews your current codebase, identifies gaps in documentation, and applies consistent commenting guidelines to ensure complete coverage across all files subject to global standards.

What happens if my code doesn't follow the commenting guidelines?

This Skill identifies deviations from global commenting rules and automatically enforces compliance. It applies the required comment syntax, tags, and documentation structure to align your codebase with centralized standards defined in your project's guidelines.