cerc-io/solidity
16
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Documentation.

Browse Source
This commit is contained in:
chriseth 2021-03-02 16:12:12 +01:00
parent d2023f5f95
commit ecdeb417c5
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/natspec-format.rst
View File

@ -109,12 +109,16 @@ Tag
``@param`` Documents a parameter just like in doxygen (must be followed by parameter name) function, event ``@param`` Documents a parameter just like in doxygen (must be followed by parameter name) function, event
``@return`` Documents the return variables of a contract's function function, public state variable ``@return`` Documents the return variables of a contract's function function, public state variable
``@inheritdoc`` Copies all missing tags from the base function (must be followed by the contract name) function, public state variable ``@inheritdoc`` Copies all missing tags from the base function (must be followed by the contract name) function, public state variable
``@custom:...`` Custom tag, semantics is application-defined everywhere
=============== ====================================================================================== ============================= =============== ====================================================================================== =============================
If your function returns multiple values, like ``(int quotient, int remainder)`` If your function returns multiple values, like ``(int quotient, int remainder)``
then use multiple ``@return`` statements in the same format as the then use multiple ``@return`` statements in the same format as the
``@param`` statements. ``@param`` statements.
Custom tags start with ``@custom:`` and can contain lowercase characters and hyphens following that.
They can be used everywhere and are part of the developer documentation.
.. _header-dynamic: .. _header-dynamic:
Dynamic expressions Dynamic expressions