natspec-standards

What problem does it solve?

This Skill provides comprehensive guidance and best practices for documenting Solidity smart contracts using NatSpec, ensuring clarity, security, and auditability.

Core Features & Use Cases

• NatSpec Tagging: Learn and apply correct tags for contracts, functions, parameters, and return values.
• Documentation Standards: Understand best practices for documenting requirements, effects, security considerations, and complex logic.
• Use Case: When writing a new smart contract or reviewing an existing one, use this Skill to ensure all public functions are clearly documented with @notice, @param, and @return tags, and that complex logic is explained in the @dev section.

Quick Start

Use the natspec-standards skill to generate documentation for the provided Solidity function.