-
Whitespace in Expressions: Avoid extraneous whitespace in the following situations — Immediately inside parenthesis, brackets or braces, with the exception of single line function declarations.
-
Control Structures: The braces denoting the body of a contract, library, functions and structs should: open on the same line as the declaration, close on their own line at the same indentation level as the beginning of the declaration. The opening brace should be preceded by a single space.
-
Function Declaration: For short function declarations, it is recommended for the opening brace of the function body to be kept on the same line as the function declaration. The closing brace should be at the same indentation level as the function declaration. The opening brace should be preceded by a single space.
-
Mappings: In variable declarations, do not separate the keyword mapping from its type by a space. Do not separate any nested mapping keyword from its type by whitespace.
-
Variable Declarations: Declarations of array variables should not have a space between the type and the brackets.
-
Strings should be quoted with double-quotes instead of single-quotes.
-
Operators: Surround operators with a single space on either side. Operators with a higher priority than others can exclude surrounding whitespace in order to denote precedence.This is meant to allow for improved readability for complex statements. You should always use the same amount of whitespace on either side of an operator
-
Layout contract elements in the following order:
-
Inside each contract, library or interface, use the following order:
- Type declarations
- State variables
- Events
- Functions
- Whitespace in Expressions
- Control Structures
- Function Declarations
- Mappings
- Variable Declaration
- Strings ->
""vs'' - Operators & Space
- Order: pragma/import/contract/types/state vars/event/functions