Skip to content

Instantly share code, notes, and snippets.

@ydm

ydm/solidity_docstring_tags.txt

Created March 6, 2023 18:02
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save ydm/1f181eab555c41de75a13dfcb8fe406c to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save ydm/1f181eab555c41de75a13dfcb8fe406c to your computer and use it in GitHub Desktop.
Download ZIP
Raw
solidity_docstring_tags.txt
@notice provide general information about the contract
@dev provide developer comments
@require describe a precondition for a function
@return describe return value
@deprecated indicate that a function is deprecated
@event describe an event emitted by a function
@inheritdoc indicate that the documentation for a function or contract is inherited from a parent contract
@param
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment