Verified:GitHub

Global Commenting

Enforces uniform, standard-based commenting across entire codebases and integrates with linters and static analysis tools for automated checks.

Updated Oct 22, 2025

Search Tags:#code quality #documentation #software development #code readability #commenting #maintainability #global standards

Ready to run

npx skills add https://github.com/raybargas/PromptDevelopment --skill global-commenting-raybargas

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: Global Commenting
Source: https://github.com/raybargas/PromptDevelopment/tree/main/.claude/skills/global-commenting
Command: npx skills add https://github.com/raybargas/PromptDevelopment --skill global-commenting-raybargas

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill enforces consistent and effective commenting practices across your entire codebase, making code easier to understand, maintain, and onboard new developers, saving significant time.

Core Features & Use Cases

Standardized Documentation: Guides Claude Code to write comments that follow predefined formats (e.g., JSDoc, Sphinx).
Improved Readability: Ensures code explanations are clear, concise, and always up-to-date.
Use Case: When reviewing a new pull request, Claude Code uses this skill to ensure all functions and complex logic blocks are adequately and consistently commented.

Quick Start

Apply the 'Global Commenting' skill to add appropriate comments to the 'data_parser.py' file.

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?▼

Consistent commenting enforces uniform style and format—like JSDoc or Sphinx—across all modules and functions. This Skill integrates with linters and static analysis tools to automatically check that comments follow project-wide guidelines, ensuring code remains readable and maintainable as your team grows.

Can I automate comment validation in my CI pipeline?▼

Yes. This Skill applies commenting standards through static analysis and linter integration, enabling automated checks at code review and CI stages. Comments are validated against global guidelines, catching inconsistencies before merge without manual inspection.

What's the best way to document complex logic blocks consistently?▼

Standardized documentation formats ensure complex logic blocks receive clear, concise explanations aligned with your codebase conventions. This Skill guides you to write comments in predefined formats, making onboarding faster and code intent transparent across modules.

Does this work with multiple programming languages in the same project?▼

This Skill enforces global commenting standards across software projects with multiple modules. It applies consistent documentation practices regardless of language specifics, referencing project-wide guidelines to maintain uniform comment style and presence across your entire codebase.

How does automated comment checking improve code reviews?▼

Automated comment checks reduce review friction by validating that functions and complex blocks follow established formats before review begins. This frees reviewers to focus on logic and design while ensuring baseline documentation completeness and consistency.

Why should I standardize comments if my code is self-explanatory?▼

Self-explanatory code still benefits from consistent documentation for context, edge cases, and design rationale. Standardized comments accelerate developer onboarding, reduce misunderstandings during maintenance, and satisfy functional and technical requirements across multi-module projects.