Tag | Description | Context |
---|---|---|
@title |
Title that describes the contract | Contract, Interfaces |
@author |
Author name | Contract, Interfaces, Functions |
@notice |
Explanation of functionality | Contract, Interfaces, Functions |
@dev |
Any extra details | Contract, Interfaces, Functions |
@param |
Parameter type followed by parameter name | Functions |
@return |
return value of a function | Functions |