cerc-io/solidity
16
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #5002 from ethereum/docs-1394-style-guide-order

Browse Source 
Docs: Added order of layout to style guide
This commit is contained in:
chriseth 2018-09-18 15:40:18 +02:00 committed by GitHub
commit 63c6007012
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/style-guide.rst
View File

@ -874,6 +874,28 @@ No::
x = y+z; x = y+z;
x +=1; x +=1;
***************
Order of Layout
***************
Layout contract elements in the following order:
1. Import statements
2. Interfaces
3. Libraries
4. Contracts
Inside each contract, library or interface, use the following order:
1. Type declarations
2. State variables
3. Events
4. Functions
.. note::
It might be clearer to declare types close to their use in events or state
variables.
****************** ******************
Naming Conventions Naming Conventions