Global Commenting

Apply standardized file headers and module-level comments across codebases.

61|4|Updated Feb 22, 2024
One-click install
npx skills add https://github.com/nanorepublica/django-prodserver --skill global-commenting-nanorepublica
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Global Commenting
Source: https://github.com/nanorepublica/django-prodserver/tree/main/.claude/skills/global-commenting
Command: npx skills add https://github.com/nanorepublica/django-prodserver --skill global-commenting-nanorepublica

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill enforces consistent commenting standards across the entire codebase, significantly improving code readability, maintainability, and developer onboarding.

Core Features & Use Cases

  • AI-Guided Adherence: Ensures all code comments follow predefined global standards for style, content, and placement.
  • Consistent Documentation: Promotes uniform documentation practices for functions, classes, and complex logic.
  • Improved Code Comprehension: Helps the AI generate and review comments that make code easier to understand for all developers.
  • Use Case: When reviewing a new module, use this Skill to automatically check if all functions, classes, and complex logic sections are adequately and consistently commented according to project standards.

Quick Start

Apply the 'Global Commenting' skill to review my Python script and suggest where comments could be added or improved.

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 code comments across my entire project?

Enforce consistent code comments by applying global commenting guidelines that standardize file headers, module-level documentation, and comment placement across all files. This Skill automatically applies those standards to your codebase, ensuring uniform style and content that improves readability and maintainability.

Can I use code commenting standards with multiple programming languages?

Yes. This Skill respects language-specific comment syntax, so it adapts commenting standards to Python, JavaScript, Java, and other languages while maintaining consistent global guidelines. Your project's documentation rules apply uniformly across all file types.

How do I integrate commenting validation into my CI workflow?

Integrate commenting validation by connecting this Skill to your linter or CI pipeline as an automated check. It validates that functions, classes, and complex logic follow your project's commenting standards during development and review, catching inconsistencies before code merges.

What should I document when reviewing a new module?

When reviewing a module, document functions, classes, and complex logic sections according to your global standards. This Skill identifies gaps in comments and suggests additions that match your project's style, making the code easier for all developers to understand.

Do I need to manually fix comments that don't follow project standards?

No. This Skill automatically generates and updates comments to align with your global standards, then applies those changes across the codebase. Manual fixes are optional—the Skill handles the standardization, preserving code semantics and project governance requirements.