crane-natspec

Document Solidity smart contracts with NatSpec by applying standardized tagging patterns to functions, errors, events, and interfaces. This enforces correct tagging and provides structured, machine-readable documentation.

Yes, you can use AsciiDoc include-tags to extract modular Solidity documentation. This approach enables structured cross-referencing and extraction across projects requiring consistent, machine-readable contract documentation.

The best way to enforce consistent NatSpec tagging is to apply validation patterns and standardized tags for functions, errors, events, and interfaces. This ensures consistent cross-referencing and resolves team tagging inconsistencies.

Yes, NatSpec supports custom tags alongside canonical tags for smart contract events, errors, and interfaces. You can use provided validation patterns and examples to generate and verify both standard and custom tag formats.

You need AsciiDoc include-tags for Solidity documentation when you want to enable structured, extractable documentation across multiple projects. This is useful when annotating contracts for consistent, machine-readable extraction.