skills.rest
ianyimi
ianyimiCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

Global Commenting

Enforce global commenting standards across multi-language code repositories.

1|Updated Jun 25, 2025
Search Tags:#development#commenting#readability#coding standards#maintainability#clarity#code documentation
One-click install
npx skills add https://github.com/ianyimi/obsidian-mcp-macros --skill global-commenting-ianyimi
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: Global Commenting
Source: https://github.com/ianyimi/obsidian-mcp-macros/tree/main/.claude/skills/global-commenting
Command: npx skills add https://github.com/ianyimi/obsidian-mcp-macros --skill global-commenting-ianyimi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill resolves the issue of inconsistent, unhelpful, or missing code comments, which makes codebases difficult to understand, maintain, and onboard new developers.

Core Features & Use Cases

  • Meaningful Comment Generation: Guides Claude to write clear, concise, and meaningful code comments that explain why code exists and its purpose.
  • Standard Adherence: Ensures adherence to project-specific commenting standards (e.g., JSDoc, Python docstrings).
  • Use Case: When reviewing a complex algorithm, activate this skill to have Claude add or refine comments, explaining the logic and assumptions, making it easier for future developers to understand and maintain.

Quick Start

Using the 'Global Commenting' skill, add appropriate docstrings and inline comments to the 'process_data' function in 'src/data_processor.py'.

Frequently Asked Questions about Global Commenting

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

FAQPage Schema
How do I add meaningful comments to explain code logic and intent?▼

Meaningful comments explain *why* code exists and its purpose, not just what it does. This Skill guides you to write clear, concise comments that help future developers understand algorithms, assumptions, and design decisions without cluttering the code.

What commenting standards should I follow across my codebase?▼

Commenting standards vary by language and project—JSDoc for JavaScript, docstrings for Python, and others. This Skill enforces adherence to your project-specific standards, ensuring consistent formatting, tag usage, and non-intrusive commentary across multi-language repositories.

How do I standardize comments during code review and generation?▼

This Skill applies global commenting standards to code generation, code reviews, and documentation workflows. It ensures outputs conform to formatting conventions and tag usage, making reviews faster and generated code immediately maintainable.

Can I use this Skill to document complex algorithms?▼

Yes. When reviewing a complex algorithm, activate this Skill to add or refine comments explaining logic and assumptions. This makes code easier for new developers to understand, maintain, and build upon without deciphering dense logic alone.

Does this Skill work with multiple programming languages?▼

Yes. This Skill applies to multi-language repositories and references global commenting guidance to satisfy functional requirements across different language conventions and frameworks while preserving code behavior.

What happens if my code comments don't match project standards?▼

Inconsistent or missing comments make codebases difficult to understand and slow onboarding. This Skill identifies non-conforming comments and enforces adherence to your global standards, improving clarity and maintainability.

Related Skills

Explore More Software Engineering Skills→
t-stringst-strings

Global Commenting

Enforce global-commenting standards across source files and documentation during code reviews.

Official
Basic
NolanPicNolanPic

Global Commenting

Enforce global commenting standards across codebases and files.

Community
Basic
ahiendzahiendz
3

lint-and-validate

Lint and statically analyze Node.js/TypeScript and Python codebases.

Community
Intermediate
jjmartresjjmartres
40

code-docs

Automate Google Style documentation across Python, Go, TypeScript, and Terraform.

Community
Advanced