真实的国产乱ⅩXXX66竹夫人,五月香六月婷婷激情综合,亚洲日本VA一区二区三区,亚洲精品一区二区三区麻豆

成都創(chuàng)新互聯(lián)網(wǎng)站制作重慶分公司

Solidity編碼規(guī)范有哪些

今天就跟大家聊聊有關(guān)Solidity 編碼規(guī)范有哪些,可能很多人都不太了解,為了讓大家更加了解,小編給大家總結(jié)了以下內(nèi)容,希望大家根據(jù)這篇文章可以有所收獲。

為蘆溪等地區(qū)用戶(hù)提供了全套網(wǎng)頁(yè)設(shè)計(jì)制作服務(wù),及蘆溪網(wǎng)站建設(shè)行業(yè)解決方案。主營(yíng)業(yè)務(wù)為成都網(wǎng)站設(shè)計(jì)、網(wǎng)站制作、蘆溪網(wǎng)站設(shè)計(jì),以傳統(tǒng)方式定制建設(shè)網(wǎng)站,并提供域名空間備案等一條龍服務(wù),秉承以專(zhuān)業(yè)、用心的態(tài)度為用戶(hù)提供真誠(chéng)的服務(wù)。我們深信只要達(dá)到每一位用戶(hù)的要求,就會(huì)得到認(rèn)可,從而選擇與我們長(zhǎng)期合作。這樣,我們也可以走得更遠(yuǎn)!

命名規(guī)范

避免使用

小寫(xiě)的l,大寫(xiě)的I,大寫(xiě)的O 應(yīng)該避免在命名中單獨(dú)出現(xiàn),因?yàn)楹苋菀桩a(chǎn)生混淆。

合約、庫(kù)、事件、枚舉及結(jié)構(gòu)體命名

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

函數(shù)、參數(shù)、變量及修飾器

函數(shù)、參數(shù)、變量及修飾器應(yīng)該使用首單詞小寫(xiě)后面單詞大寫(xiě)的方式,這個(gè)方式也稱(chēng)為:(?。劮迨矫?,是一種混合大小寫(xiě)的方式,如:

  • 函數(shù)名應(yīng)該如:getBalance,transfer,verifyOwner,addMember。

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

  • 修飾器應(yīng)該如:onlyAfter,onlyOwner。

代碼格式相關(guān)

縮進(jìn)

使用空格(spaces)而不是Tab, 縮進(jìn)應(yīng)該是4個(gè)空格

空行

合約之間應(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 {
        ...
    }
}

沒(méi)有實(shí)現(xiàn)的話,空行可以省去,如:

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

而不是:

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

左括號(hào)應(yīng)該跟定義在一行

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

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

而不是:

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

左括號(hào)應(yīng)該跟條件控制在一行

在使用if, else, while, for 時(shí),推薦的寫(xiě)法是:

if (...) {
    ...
}

for (...) {
    ...
}

而不是:

if (...)
{
    ...
}

while(...){
}

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

如果控制語(yǔ)句內(nèi)只有一行,括號(hào)可省略,如:

if (x < 10)
    x += 1;

但像下面一個(gè)語(yǔ)句有多方就不能省略,如:

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

表達(dá)式內(nèi)的空格

  • 一個(gè)單行的表達(dá)里,在小括號(hào)、中括號(hào)、大括號(hào)里應(yīng)該避免不必要的空格,例如推薦使用:

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

    而不是:

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

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

    function singleLine() public { spam(); }

  • 分號(hào);前不應(yīng)該有空格,例如推薦使用:

    function spam(uint i, Coin coin) public;

    而不是:

    function spam(uint i , Coin coin) public ;

  • 不要為對(duì)齊添加不必要的空格,例如推薦使用:

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

    而不是:

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

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

    function() public {
        ...
    }

    而不是:

    function () public {
        ...
    }

控制每一行長(zhǎng)度

每行不應(yīng)該太長(zhǎng),最好在79(或99)個(gè)字符以?xún)?nèi),函數(shù)的參數(shù)應(yīng)該是單獨(dú)的行,且只有一個(gè)縮進(jìn),例如推薦的方式是:

thisFunctionCallIsReallyLong(
    longArgument1,
    longArgument2,
    longArgument3
);

而不是:

thisFunctionCallIsReallyLong(longArgument1,
                              longArgument2,
                              longArgument3
);

thisFunctionCallIsReallyLong(longArgument1,
    longArgument2,
    longArgument3
);

thisFunctionCallIsReallyLong(
    longArgument1, longArgument2,
    longArgument3
);

thisFunctionCallIsReallyLong(
longArgument1,
longArgument2,
longArgument3
);

thisFunctionCallIsReallyLong(
    longArgument1,
    longArgument2,
    longArgument3);

對(duì)應(yīng)的賦值語(yǔ)句應(yīng)該是這樣寫(xiě):

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 編碼

引入文件應(yīng)該在最上方

建議使用:

import "owned";


contract A {
    ...
}


contract B is owned {
    ...
}

而不是:

contract A {
    ...
}


import "owned";


contract B is owned {
    ...
}

函數(shù)編寫(xiě)規(guī)范

函數(shù)的順序

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

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

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

  3. 外部函數(shù)(external)

  4. 公有函數(shù)(public)

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

  6. 私有函數(shù)(private)

同一類(lèi)函數(shù)時(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ù)的可見(jiàn)性

所有的函數(shù)(包括構(gòu)造函數(shù))應(yīng)該在定義的時(shí)候明確函數(shù)的可見(jiàn)性,例如應(yīng)該使用:

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

而不是

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

可見(jiàn)性應(yīng)該在修飾符前面

函數(shù)的可見(jiàn)性應(yīng)該寫(xiě)在自定義的函數(shù)修飾符前面,例如:

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

而不是

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

區(qū)分函數(shù)和事件

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

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

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

常量

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

看完上述內(nèi)容,你們對(duì)Solidity 編碼規(guī)范有哪些有進(jìn)一步的了解嗎?如果還想了解更多知識(shí)或者相關(guān)內(nèi)容,請(qǐng)關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道,感謝大家的支持。


新聞標(biāo)題:Solidity編碼規(guī)范有哪些
轉(zhuǎn)載來(lái)源:http://weahome.cn/article/jgjoch.html

其他資訊

在線咨詢(xún)

微信咨詢(xún)

電話咨詢(xún)

028-86922220(工作日)

18980820575(7×24)

提交需求

返回頂部