![]() Used then the Solidity compiler will interpret a /// or /** comment The following table explains the purpose of each contract Tree Tags Īll tags are optional. Gardner /// You can use this contract for only the most basic simulation /// All function calls are currently implemented without side effects /// This is an experimental contract. SPDX-License-Identifier: GPL-3.0 pragma solidity >= 0.8. The following example shows a contract and a function using all available tags. These are most likelyĪccomplished via the tag, and a good use case is analysis and verificationĭocumentation is inserted above each contract, interface, library,įunction, and event using the Doxygen notation format.Ī public state variable is equivalent to a functionįor Solidity you may choose /// for single or multi-lineįor Vyper, use """ indented to the inner contents with bare ![]() NatSpec may also include annotations used by third-party tools. Output of the Solidity compiler, which extracts these comments into a machine-readable Use, and which are understood by the Solidity compiler. NatSpec includes the formatting for comments that the smart contract author will It is recommended that Solidity contracts are fully annotated using NatSpec forĪll public interfaces (everything in the ABI). Time that they will interact with the contract (i.e. These messages may be shown to the end user (the human) at the This documentation is segmented into developer-focused messages and end-user-facing Please carefully examine the supported tags While it uses Doxygen-style comments and tags, there is no intention to keep
0 Comments
Leave a Reply. |