solidity-comment-style

Community

清理 Solidity 注释,提升代码可读性与风格

Authorphpmac
Version1.0.0
Installs0

System Documentation

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.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: solidity-comment-style
Download link: https://github.com/phpmac/skills/archive/main.zip#solidity-comment-style

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.