skills.rest
jaypaulb
jaypaulbCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

Global Commenting

Enforce standardized global commenting rules across codebases during generation and review.

Updated Aug 23, 2026
Search Tags:#AI guidance#documentation#software development#technical writing#code readability#maintainability#code commenting
One-click install
npx skills add https://github.com/jaypaulb/CanvusAPI-LLMDemo --skill global-commenting-jaypaulb
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: Global Commenting
Source: https://github.com/jaypaulb/CanvusAPI-LLMDemo/tree/main/.claude/skills/global-commenting
Command: npx skills add https://github.com/jaypaulb/CanvusAPI-LLMDemo --skill global-commenting-jaypaulb

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Poor or inconsistent commenting makes code harder to understand, especially for new team members or when revisiting old code. This Skill guides the AI to generate clear, concise, and standardized comments, improving code readability and maintainability.

Core Features & Use Cases

  • Automated Docstring Generation: Instructs AI to create comprehensive docstrings for functions and classes.
  • Consistent Inline Comments: Guides AI on when and how to add explanatory inline comments.
  • Use Case: After the AI generates a complex algorithm, use this Skill to have it automatically add detailed docstrings and inline comments, explaining the logic and parameters, making the code immediately understandable.

Quick Start

Add comprehensive docstrings to all functions in the attached calculator.js file, explaining their purpose, parameters, and return values.

Frequently Asked Questions about Global Commenting

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

FAQPage Schema
How do I add standardized comments to my codebase?▼

Standardized commenting enforces consistent comment formats across your codebase, improving readability and maintainability. This Skill guides AI to generate uniform docstrings, inline comments, and documentation that follow your team's commenting conventions, making code immediately understandable to new team members and during code reviews.

What's the best way to document functions and classes with AI?▼

AI-guided documentation generates comprehensive docstrings for functions and classes, explaining purpose, parameters, and return values. This Skill ensures all generated docstrings follow your global commenting standards, eliminating inconsistency and reducing manual documentation effort during code generation workflows.

Can I enforce consistent commenting rules across multiple modules?▼

Yes. This Skill applies standardized global commenting rules uniformly across modules and files. It propagates and preserves comments consistently during code generation, linting, and code review, ensuring your entire codebase adheres to documented commenting standards without manual enforcement.

How do I improve code readability for new team members?▼

Clear, standardized comments explain complex logic and design decisions. This Skill instructs AI to add consistent inline comments alongside generated code, making algorithms, parameters, and intent explicit so new developers understand your codebase faster without extensive context gathering.

Does this integrate with automated code review and linting tools?▼

Yes. This Skill integrates with automated tooling and coding standards checks, applying global commenting rules during code review and linting workflows. It ensures generated code meets your organization's documentation requirements automatically, reducing review cycles and standardization gaps.

Why should comments be consistent across a codebase?▼

Inconsistent commenting creates confusion, slows onboarding, and makes maintenance harder. Standardized comments establish a single source of truth for documentation style, making code predictable and easier to navigate across teams and time, especially when revisiting old code or merging contributions.

Related Skills

Explore More Software Engineering Skills→
ORANGECRAB13ORANGECRAB13

docstring

Generate Google-style docstrings for Python modules and classes.

Community
Intermediate
onbjergonbjerg
4

rust

Format and lint Rust code with cargo fmt and cargo clippy.

Community
Intermediate
ricardorochericardoroche
2

docstring-format

Enforce Google-style docstrings for Python functions and classes.

Community
Intermediate
rennerenne

php-coding-style

Enforce Moodle PHP coding style with PSR-12 and PSR-1 rules.

Community
Basic