Agent skill

self-documenting-code

Use descriptive names for functions, variables, and classes that explain their purpose Use when documenting code and APIs. Documentation category skill.

Stars 163
Forks 31

Install this agent skill to your Project

npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/other/other/self-documenting-code

Metadata

Additional technical details for this skill

category
Documentation
priority
high
is built in
YES
session guardian id
builtin_self_documenting_code

SKILL.md

Self-Documenting Code

Use descriptive names for functions, variables, and classes that explain their purpose. Extract complex expressions into well-named variables. Break complex functions into smaller, named functions. Choose clear names over abbreviations. If you need to write a comment explaining what code does, first try to rewrite the code to be clearer. Reserve comments for explaining why, not what.

Expand your agent's capabilities with these related and highly-rated skills.

Didn't find tool you were looking for?

Be as detailed as possible for better results