Global Commenting

Enforce global commenting standards across codebases and files.

Updated May 19, 2025

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

Ready to run

npx skills add https://github.com/NolanPic/churchfeed --skill global-commenting-nolanpic

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill addresses the issue of inconsistent or missing code comments, making code harder to understand and maintain for other developers.

Core Features & Use Cases

Standardized Comments: Guides Claude to write comments that follow project-specific formats (e.g., JSDoc, Python docstrings).
Improved Readability: Ensures code is well-documented, making it easier for new team members to onboard and for existing members to understand complex logic.
Use Case: When reviewing a new pull request, activate this skill to ensure Claude adds or refines comments in functions and classes to meet the project's documentation standards, enhancing code clarity.

Quick Start

Apply the 'Global Commenting' skill to add JSDoc comments to all functions in utility_helpers.js.

Frequently Asked Questions about Global Commenting

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

FAQPage Schema

How do I ensure consistent code comments across my project?▼

Consistent code comments follow project-specific standards like JSDoc or docstrings. This Skill guides Claude to apply those formatting rules globally across files, enforcing comment placement, structure, and scope so all developers document code the same way.

What's the best way to add standardized comments to existing code?▼

Apply commenting standards by referencing your project's conventions, then have Claude process files to add or refine comments in functions and classes. This Skill ensures new comments match your defined format and placement rules across the codebase.

Can I use this to enforce JSDoc or docstring formats in my codebase?▼

Yes. This Skill enforces project-specific commenting standards including JSDoc, Python docstrings, and custom formats. It guides Claude to comply with your defined comment style, scope, and update workflow across multiple modules and files.

Why should I standardize code comments before code review?▼

Standardized comments improve code readability and maintainability, helping new team members onboard faster and existing members understand complex logic. Activating this Skill during pull request review ensures documentation meets project standards before merge.

How does global commenting affect code documentation and refactoring?▼

Global commenting enforces documentation standards across related files during refactoring or review, ensuring comment placement, formatting, and scope stay consistent. This makes code easier to maintain and understand when modules interact or change together.

What's the difference between local and global code comments?▼

Local comments document single functions; global comments affect multiple modules and files. This Skill addresses global commenting—standardizing documentation across codebases where interconnected files or refactoring require consistent, coordinated comment updates.