solidity-comment-style

Remove redundant Solidity comments while preserving essential documentation and standardizing formats.

Updated Aug 23, 2026

Search Tags:#documentation #solidity #smart-contract #code-readability #comment-cleanup #comment-standards

Ready to run

npx skills add https://github.com/phpmac/skills --skill solidity-comment-style

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: solidity-comment-style
Source: https://github.com/phpmac/skills/tree/main/plugins/my-agents/skills/solidity-comment-style
Command: npx skills add https://github.com/phpmac/skills --skill solidity-comment-style

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Solidity contracts often accumulate verbose and outdated comments that hinder readability and maintainability. This Skill provides a structured, guideline-based approach to clean up comments while preserving essential information.

Core Features & Use Cases

Retains core mechanism notes in top-of-file comments while removing detailed procedural notes
Simplifies function and event annotations to one-line descriptions with key parameters
Use Case: refactor legacy contracts to improve readability before audits or reviews

Quick Start

Apply the Solidity comment-cleanup guidelines to your contract files to reduce boilerplate while preserving essential information.

Frequently Asked Questions about solidity-comment-style

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

FAQPage Schema

How do I clean up redundant comments in Solidity smart contracts?▼

To clean up redundant comments in Solidity smart contracts, apply structured guidelines to remove verbose boilerplate while preserving essential top-level mechanism notes and standardizing function annotations. This process improves contract readability and maintainability before code reviews.

What is the best way to refactor legacy Solidity comments for readability?▼

Refactoring legacy Solidity comments for readability involves simplifying event and function annotations to one-line descriptions with key parameters. This reduces outdated boilerplate while enforcing a policy to standardize comment formats across the codebase.

Does cleaning up Solidity comments preserve NatSpec annotations?▼

Cleaning up Solidity comments preserves NatSpec annotations such as @title, @param, and @return. The cleanup policy enforces the retention of essential documentation while targeting and removing lengthy boilerplate and procedural notes.

When do I need to standardize comment formats in Solidity development?▼

You need to standardize comment formats in Solidity development during refactoring and code reviews. Standardizing formats ensures that top-level comments retain core mechanism notes while detailed procedural notes are removed for better maintainability.

Can I remove boilerplate from Solidity contracts without losing documentation?▼

You can remove boilerplate from Solidity contracts without losing documentation by applying a targeted cleanup policy. This policy removes verbose procedural notes while explicitly preserving essential documentation like NatSpec annotations and core mechanism notes.

Why should I simplify function annotations in Solidity smart contracts?▼

Simplifying function annotations in Solidity smart contracts improves readability by reducing verbose descriptions to one-line summaries with key parameters. This approach removes outdated comments and ensures the codebase remains maintainable for future audits.