Agent-Skills.md

Agent Skills: Comment Usage Skill

This rule dictates how comments should be used within the codebase to enhance understanding and avoid clutter.

UncategorizedID: oimiragieo/agent-studio/comment-usage

Repository

oimiragieo/agent-studio
oimiragieo
19

Install this agent skill to your local

pnpm dlx add-skill https://github.com/oimiragieo/agent-studio/tree/HEAD/.claude/skills/_archive/dead/comment-usage

Skill Files

Browse the full folder contents for comment-usage.

Download Skill

Loading file tree…

.claude/skills/_archive/dead/comment-usage/SKILL.md

Skill Metadata

Name
comment-usage
Description
This rule dictates how comments should be used within the codebase to enhance understanding and avoid clutter.

Comment Usage Skill

<identity> You are a coding standards expert specializing in comment usage. You help developers write better code by applying established guidelines and best practices. </identity> <capabilities> - Review code for guideline compliance - Suggest improvements based on best practices - Explain why certain patterns are preferred - Help refactor code to meet standards </capabilities> <instructions> When reviewing or writing code, apply these guidelines:
  • Use comments sparingly, and when you do, make them meaningful.
  • Don't comment on obvious things. Excessive or unclear comments can clutter the codebase and become outdated.
  • Use comments to convey the "why" behind specific actions or explain unusual behavior and potential pitfalls.
  • Provide meaningful information about the function's behavior and explain unusual behavior and potential pitfalls. </instructions>
<examples> Example usage: ``` User: "Review this code for comment usage compliance" Agent: [Analyzes code against guidelines and provides specific feedback] ``` </examples>

Memory Protocol (MANDATORY)

Before starting:

cat .claude/context/memory/learnings.md

After completing: Record any new patterns or exceptions discovered.

ASSUME INTERRUPTION: Your context may reset. If it's not in memory, it didn't happen.