diff options
| author | Svetlin Nakov <nakov@users.noreply.github.com> | 2017-10-25 15:33:26 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-10-25 15:33:26 +0800 |
| commit | f39cf7be41a4c781fdcc71b5bc86b16764241d4f (patch) | |
| tree | c9b8918c838ab4cf5e6ee76646d6a38ad1a59529 /docs | |
| parent | cacc0e4b469e179b8e2ce73bf217b65ad720630c (diff) | |
| download | dexon-solidity-f39cf7be41a4c781fdcc71b5bc86b16764241d4f.tar.gz dexon-solidity-f39cf7be41a4c781fdcc71b5bc86b16764241d4f.tar.zst dexon-solidity-f39cf7be41a4c781fdcc71b5bc86b16764241d4f.zip | |
Improved the "Naming" section
Improved the "Naming" section. Added naming examples. Improved consistency.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/style-guide.rst | 34 |
1 files changed, 18 insertions, 16 deletions
diff --git a/docs/style-guide.rst b/docs/style-guide.rst index 0742d2e9..ee2be23e 100644 --- a/docs/style-guide.rst +++ b/docs/style-guide.rst @@ -696,49 +696,51 @@ indistinguishable from the numerals one and zero. Contract and Library Names ========================== -Contracts and libraries should be named using the CapWords style. +Contracts and libraries should be named using the CapWords style. Examples: ``SimpleToken``, ``SmartBank``, ``CertificateHashRepository``, ``Player``. -Events -====== +Event Names +=========== -Events should be named using the CapWords style. +Events should be named using the CapWords style. Examples: ``Deposit``, ``Transfer``, ``Approval``, ``BeforeTransfer``, ``AfterTransfer``. Function Names ============== -Functions should use mixedCase. +Functions should use mixedCase. Examples: ``getBalance``, ``transfer``, ``verifyOwner``, ``addMember``, ``changeOwner``. -Function Arguments -================== +Function Arguments Names +======================== + +Function arguments should use mixedCase. Examples: ``initialSupply``, ``account``, ``recipientAddress``, ``senderAddress``, ``newOwner``. When writing library functions that operate on a custom struct, the struct should be the first argument and should always be named ``self``. -Local and State Variables -========================= +Local and State Variables Names +=============================== -Use mixedCase. +Use mixedCase. Examples: ``totalSupply``, ``remainingSupply``, ``balancesOf``, ``creatorAddress``, ``isPreSale``, ``tokenExchangeRate``. Constants ========= Constants should be named with all capital letters with underscores separating -words. (for example:``MAX_BLOCKS``) +words. Examples: ``MAX_BLOCKS``, `TOKEN_NAME`, ``TOKEN_TICKER``, ``CONTRACT_VERSION``. -Modifiers -========= +Modifier Names +============== -Use mixedCase. +Use mixedCase. Examples: ``onlyBy``, ``onlyAfter``, ``onlyDuringThePreSale``. -Avoiding Collisions -=================== +Avoiding Naming Collisions +========================== * ``single_trailing_underscore_`` |