skills.rest
frankdevlabs
frankdevlabsCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

Global Commenting

Refactor code for clarity and add concise comments explaining complex logic.

Updated Aug 23, 2026
Search Tags:#code quality#best practices#documentation#refactoring#clean code#readability#comments
Ready to run
npx skills add https://github.com/frankdevlabs/compilothq --skill global-commenting-frankdevlabs
💬 Prompt for ChatGPT / Claude Chat▼
Please help me install this Agent Skill.
Skill: Global Commenting
Source: https://github.com/frankdevlabs/compilothq/tree/main/.claude/skills/global-commenting
Command: npx skills add https://github.com/frankdevlabs/compilothq --skill global-commenting-frankdevlabs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Excessive, outdated, or missing comments lead to confusion, maintenance overhead, and a codebase that is difficult to understand and evolve.

Core Features & Use Cases

  • Self-Documenting Code: Prioritize clear structure, meaningful variable and function names over relying heavily on comments to explain what the code does.
  • Explain Complex Logic: Add concise, minimal comments only to explain the "why" behind large sections of complex code logic or non-obvious implementation decisions.
  • Evergreen Information: Ensure comments provide long-term value, documenting business rules, algorithms, or constraints that cannot be understood from the code alone.

Quick Start

Review the calculateComplexDiscount function. Refactor it for clarity, and add a concise comment explaining the business rule behind the discount calculation.