CODE_STYLE.md

Code Style

We value clean code and consistency, and those are prerequisites for us to include new code in the repository. Before proposing a change, please read this document and take some time to familiarize yourself with the style of the existing codebase.

Solidity code

In order to be consistent with all the other Solidity projects, we follow the official recommendations documented in the Solidity style guide.

Any exception or additions specific to our project are documented below.

Naming

• Try to avoid acronyms and abbreviations.

• All state variables should be private.

• Private state variables should have an underscore prefix.

  contract TestContract {
    uint256 private _privateVar;
    uint256 internal _internalVar;
  }
  

• Parameters must not be prefixed with an underscore.

  function test(uint256 testParameter1, uint256 testParameter2) {
  ...
  }
  

• Internal and private functions should have an underscore prefix.

  function _testInternal() internal {
    ...
  }
  

  function _testPrivate() private {
    ...
  }
  

• Events should be emitted immediately after the state change that they represent, and consequently they should be named in past tense.

  function _burn(address _who, uint256 _value) internal {
    super._burn(_who, _value);
    emit TokensBurned(_who, _value);
  }
  

  Some standards (e.g. ERC20) use present tense, and in those cases the standard specification prevails.