摘要：命名規(guī)范避免使用小寫的，大寫的，大寫的應(yīng)該避免在命名中多帶帶出現(xiàn)，因為很容易產(chǎn)生混淆。對于函數(shù)，始終以小寫字母開頭，構(gòu)造函數(shù)除外。

本文首發(fā)于深入淺出區(qū)塊鏈社區(qū)
原文鏈接:智能合約最佳實踐之Solidity編碼規(guī)范原文已更新，請讀者前往原文閱讀

每一門語言都有其相應(yīng)的編碼規(guī)范， Solidity 也一樣， 下面官方推薦的規(guī)范及我的總結(jié)，供大家參考，希望可以幫助大家寫出更好規(guī)范的智能合約。

小寫的l，大寫的I，大寫的O 應(yīng)該避免在命名中多帶帶出現(xiàn)，因為很容易產(chǎn)生混淆。

合約、庫、事件及結(jié)構(gòu)體命名應(yīng)該使用單詞首字母大寫的方式，這個方式也稱為：帕斯卡命名法或大駝峰式命名法，比如：SimpleToken， SmartBank， CertificateHashRepository，Player。

函數(shù)、參數(shù)、變量及修飾器應(yīng)該使用首單詞小寫后面單詞大寫的方式，這個方式也稱為：（?。劮迨矫ǎ且环N混合大小寫的方式，如：

函數(shù)名應(yīng)該如：getBalance，transfer，verifyOwner，addMember。

參數(shù)和變量應(yīng)該如：initialSupply，senderAddress，account，isPreSale。

修飾器應(yīng)該如：onlyAfter，onlyOwner。

使用空格（spaces）而不是Tab, 縮進應(yīng)該是4個空格

合約之間應(yīng)該有空行，例如：

contract A {
    ...
}
    
    
contract B {
    ...
}
    
    
contract C {
    ...
}

而不是使用：

contract A {
    ...
}
contract B {
    ...
}
    
contract C {
    ...
}

函數(shù)之間應(yīng)該有空行，例如：

contract A {
    function spam() public {
        ...
    }
    
    function ham() public {
        ...
    }
}

沒有實現(xiàn)的話，空行可以省去，如：

contract A {
    function spam() public;
    function ham() public;
}

而不是：

contract A {
    function spam() public {
        ...
    }
    function ham() public {
        ...
    }
}

定義包括合約定義、函數(shù)定義、庫定義、結(jié)構(gòu)體定義等等，例如推薦使用：

 contract Coin {
    struct Bank {
        address owner;
        uint balance;
    }
}

而不是：

contract Coin
{
    struct Bank {
        address owner;
        uint balance;
    }
}

在使用if, else, while, for 時，推薦的寫法是：

if (...) {
    ...
}

for (...) {
    ...
}

而不是：

if (...)
{
    ...
}

while(...){
}

for (...) {
    ...;}

如果控制語句內(nèi)只有一行，括號可省略，如：

if (x < 10)
    x += 1;

但像下面一個語句有多方就不能省略，如：

if (x < 10)
    someArray.push(Coin({
        name: "spam",
        value: 42
    }));

一個單行的表達(dá)里，在小括號、中括號、大括號里應(yīng)該避免不必要的空格，例如推薦使用：

spam(ham[1], Coin({name: "ham"}));

而不是：

spam( ham[ 1 ], Coin( { name: "ham" } ) );

有一種例外是，結(jié)尾的括號跟在結(jié)束的分號后面， 應(yīng)該加一個空格，如下面的方式也是推薦的：

function singleLine() public { spam(); }

分號；前不應(yīng)該有空格，例如推薦使用：

function spam(uint i, Coin coin) public;

而不是：

function spam(uint i , Coin coin) public ;

不要為對齊添加不必要的空格，例如推薦使用：

x = 1;
y = 2;
long_variable = 3;

而不是：

x             = 1;
y             = 2;
long_variable = 3;

回退函數(shù)不應(yīng)該有空格，例如推薦使用：

function() public {
    ...
}

而不是：

function () public {
    ...
}

每行不應(yīng)該太長，最好在79（或99）個字符以內(nèi)，函數(shù)的參數(shù)應(yīng)該是多帶帶的行，且只有一個縮進，例如推薦的方式是：

thisFunctionCallIsReallyLong(
    longArgument1,
    longArgument2,
    longArgument3
);

而不是：

thisFunctionCallIsReallyLong(longArgument1,
                              longArgument2,
                              longArgument3
);

thisFunctionCallIsReallyLong(longArgument1,
    longArgument2,
    longArgument3
);

thisFunctionCallIsReallyLong(
    longArgument1, longArgument2,
    longArgument3
);

thisFunctionCallIsReallyLong(
longArgument1,
longArgument2,
longArgument3
);

thisFunctionCallIsReallyLong(
    longArgument1,
    longArgument2,
    longArgument3);

對應(yīng)的賦值語句應(yīng)該是這樣寫：

thisIsALongNestedMapping[being][set][to_some_value] = someFunction(
   argument1,
   argument2,
   argument3,
   argument4
);

而不是：

thisIsALongNestedMapping[being][set][to_some_value] = someFunction(argument1,
                                                                   argument2,
                                                                   argument3,
                                                                   argument4);

事件定義也應(yīng)該遵循同樣的原則，例如應(yīng)該使用：

event LongAndLotsOfArgs(
    adress sender,
    adress recipient,
    uint256 publicKey,
    uint256 amount,
    bytes32[] options
);

LongAndLotsOfArgs(
    sender,
    recipient,
    publicKey,
    amount,
    options
);

而不是：

event LongAndLotsOfArgs(adress sender,
                        adress recipient,
                        uint256 publicKey,
                        uint256 amount,
                        bytes32[] options);

LongAndLotsOfArgs(sender,
                  recipient,
                  publicKey,
                  amount,
                  options);

推薦使用utf-8 及 ASCII 編碼

建議使用：

import "owned";


contract A {
    ...
}


contract B is owned {
    ...
}

而不是：

contract A {
    ...
}


import "owned";


contract B is owned {
    ...
}

在編寫函數(shù)的時候，應(yīng)該讓大家容易找到構(gòu)造函數(shù)，回退函數(shù)，官方推薦的的函數(shù)順序是：

構(gòu)造函數(shù)

回退函數(shù) (如果有)

外部函數(shù)（external）

公有函數(shù)(public)

內(nèi)部函數(shù)(internal)

私有函數(shù)（private）

同一類函數(shù)時，constant函數(shù)放在后面， 例如推薦方式為：

 contract A {
    // 構(gòu)造函數(shù)
    function A() public {
        ...
    }

    // 回退函數(shù)
    function() public {
        ...
    }

    // 外部函數(shù)
    // ...

    // 帶有constant 外部函數(shù) 
    // ...

    // 公有函數(shù)
    // ...

    // 內(nèi)部函數(shù)
    // ...

    // 私有函數(shù)
    // ...
}

而不是下面的函數(shù)順序：

 contract A {


    // 外部函數(shù)
    // ...

    // 公有函數(shù)
    // ...

    // 內(nèi)部函數(shù)
    // ...
    
    function A() public {
        ...
    }

    function() public {
        ...
    }

    // 私有函數(shù)
    // ...
}

所有的函數(shù)（包括構(gòu)造函數(shù)）應(yīng)該在定義的時候明確函數(shù)的可見性，例如應(yīng)該使用：

function explicitlyPublic(uint val) public {
    doSomething();
}

而不是

function implicitlyPublic(uint val) {
    doSomething();
}

函數(shù)的可見性應(yīng)該寫在自定義的函數(shù)修飾符前面，例如：

function kill() public onlyowner {
    selfdestruct(owner);
}

而不是

function kill() onlyowner public {
    selfdestruct(owner);
}

為了防止函數(shù)和事件（Event）產(chǎn)生混淆，聲明一個事件使用大寫并加入前綴（可使用LOG）。對于函數(shù)， 始終以小寫字母開頭，構(gòu)造函數(shù)除外。

// 不建議
event Transfer() {}
function transfer() {}

// 建議
event LogTransfer() {}
function transfer() external {}

常量應(yīng)該使用全大寫及下劃線分割大詞的方式，如：MAX_BLOCKS，TOKEN_NAME， CONTRACT_VERSION。

我們也推出了目前市面上最全的視頻教程：深入詳解以太坊智能合約語言Solidity
目前我們也在招募體驗師，可以點擊鏈接了解。

Solidity style-guide

? 深入淺出區(qū)塊鏈 - 系統(tǒng)學(xué)習(xí)區(qū)塊鏈，打造最好的區(qū)塊鏈技術(shù)博客。

? 我的知識星球為各位解答區(qū)塊鏈技術(shù)問題，歡迎加入討論。

? 關(guān)注公眾號“深入淺出區(qū)塊鏈技術(shù)”第一時間獲取區(qū)塊鏈技術(shù)信息。