The standard in the solidity community is to use a format called natspec, which looks like this:
solidity
/// @title A contract for basic math operations/// @author H4XF13LD MORRIS 💯💯😎💯💯/// @notice For now, this contract just adds a multiply functioncontract Math{/// @notice Multiplies 2 numbers together/// @paramx the first uint./// @paramy the second uint./// @returnz the product of (x * y)/// @dev This function does not currently check for overflowsfunctionmultiply(uintx,uinty)returns(uintz){// This is just a normal comment, and won't get picked up by natspec z = x * y;}}
@notice explains to a user what the contract / function does. @dev is for explaining extra details to developers. At the very least, leave a @dev note explaining what each function does.
The standard in the solidity community is to use a format called natspec, which looks like this:
@notice
 explains to a user what the contract / function does.Â@dev
 is for explaining extra details to developers. At the very least, leave aÂ@dev
 note explaining what each function does.