专栏首页深入浅出区块链技术智能合约最佳实践 之 Solidity 编码规范

智能合约最佳实践 之 Solidity 编码规范

每一门语言都有其相应的编码规范, Solidity 也一样, 下面官方推荐的规范及我的总结,供大家参考,希望可以帮助大家写出更好规范的智能合约。

命名规范

避免使用

小写的l,大写的I,大写的O 应该避免在命名中单独出现,因为很容易产生混淆。

合约、库、事件、枚举及结构体命名

合约、库、事件及结构体命名应该使用单词首字母大写的方式,这个方式也称为:帕斯卡命名法或大驼峰式命名法,比如:SimpleToken, SmartBank, CertificateHashRepository,Player。

函数、参数、变量及修饰器

函数、参数、变量及修饰器应该使用首单词小写后面单词大写的方式,这个方式也称为:(小)驼峰式命名法,是一种混合大小写的方式,如:

  • 函数名应该如:getBalance,transfer,verifyOwner,addMember。
  • 参数和变量应该如:initialSupply,senderAddress,account,isPreSale。
  • 修饰器应该如:onlyAfter,onlyOwner。

代码格式相关

缩进

使用空格(spaces)而不是Tab, 缩进应该是4个空格

空行

合约之间应该有空行,例如:

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

而不是使用:

contract A {
    ...
}
contract B {
    ...
}
    
contract C {
    ...
}
  • 函数之间应该有空行,例如:
contract A {
    function spam() public {
        ...
    }
    
    function ham() public {
        ...
    }
}

没有实现的话,空行可以省去,如:

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

而不是:

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

左括号应该跟定义在一行

定义包括合约定义、函数定义、库定义、结构体定义等等,例如推荐使用:

 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 (...) {
    ...;}

如果控制语句内只有一行,括号可省略,如:

if (x < 10)
    x += 1;

但像下面一个语句有多方就不能省略,如:

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

表达式内的空格

  • 一个单行的表达里,在小括号、中括号、大括号里应该避免不必要的空格,例如推荐使用: spam(ham[1], Coin({name: "ham"}));
而不是:1
spam( ham[ 1 ], Coin( { name: "ham" } ) );
有一种例外是,结尾的括号跟在结束的分号后面, 应该加一个空格,如下面的方式也是推荐的:1
function singleLine() public { spam(); }
  • 分号;前不应该有空格,例如推荐使用: function spam(uint i, Coin coin) public;
而不是:1
function spam(uint i , Coin coin) public ;
  • 不要为对齐添加不必要的空格,例如推荐使用: x = 1; y = 2; long_variable = 3;
而不是:1
2
3
x             = 1;
y             = 2;
long_variable = 3;
  • 回退函数不应该有空格,例如推荐使用: function() public { ... } ``` 而不是: ```js function () public { ... }

控制每一行长度

每行不应该太长,最好在79(或99)个字符以内,函数的参数应该是单独的行,且只有一个缩进,例如推荐的方式是:

thisFunctionCallIsReallyLong(
    longArgument1,
    longArgument2,
    longArgument3
);

而不是:

thisFunctionCallIsReallyLong(longArgument1,
                              longArgument2,
                              longArgument3
);

thisFunctionCallIsReallyLong(longArgument1,
    longArgument2,
    longArgument3
);

thisFunctionCallIsReallyLong(
    longArgument1, longArgument2,
    longArgument3
);

thisFunctionCallIsReallyLong(
longArgument1,
longArgument2,
longArgument3
);

thisFunctionCallIsReallyLong(
    longArgument1,
    longArgument2,
    longArgument3);

对应的赋值语句应该是这样写:

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

而不是:

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

事件定义也应该遵循同样的原则,例如应该使用:

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 {
    ...
}

函数编写规范

函数的顺序

在编写函数的时候,应该让大家容易找到构造函数,回退函数,官方推荐的的函数顺序是:

  1. 构造函数
  2. 回退函数 (如果有)
  3. 外部函数(external)
  4. 公有函数(public)
  5. 内部函数(internal)
  6. 私有函数(private)

同一类函数时,constant函数放在后面, 例如推荐方式为:

 contract A {
    // 构造函数
    function A() public {
        ...
    }

    // 回退函数
    function() public {
        ...
    }

    // 外部函数
    // ...

    // 带有constant 外部函数 
    // ...

    // 公有函数
    // ...

    // 内部函数
    // ...

    // 私有函数
    // ...
}

而不是下面的函数顺序:

 contract A {


    // 外部函数
    // ...

    // 公有函数
    // ...

    // 内部函数
    // ...
    
    function A() public {
        ...
    }

    function() public {
        ...
    }

    // 私有函数
    // ...
}

明确函数的可见性

所有的函数(包括构造函数)应该在定义的时候明确函数的可见性,例如应该使用:

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

而不是

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

可见性应该在修饰符前面

函数的可见性应该写在自定义的函数修饰符前面,例如:

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

而不是

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

区分函数和事件

为了防止函数和事件(Event)产生混淆,声明一个事件使用大写并加入前缀(可使用LOG)。对于函数, 始终以小写字母开头,构造函数除外。

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

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

常量

常量应该使用全大写及下划线分割大词的方式,如:MAX_BLOCKS,TOKEN_NAME, CONTRACT_VERSION。

本文分享自微信公众号 - 深入浅出区块链技术(blockchaincore),作者:Tiny熊

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2018-05-04

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 【译】Solidity 0.6.x更新:继承

    与面向对象编程类似,Solidity是一种面向合约的语言,广泛使用继承和多态,并且对于语言的发展至关重要。Solidity开发人员如果不使用这些特性很难分离逻辑...

    Tiny熊
  • 一步步教你开发、部署第一个Dapp应用 - 宠物商店

    今天我们来编写一个完整的去中心化应用(Dapps), 本文可以和编写智能合约结合起来看。

    Tiny熊
  • 跟我学 Solidity :合约的创建和继承

    欢迎阅读“跟我学 Solidity ”系列中的又一篇文章。在上一篇文章[4],我们看到了如何使用函数,并运用了到目前为止所学到的一切来构建一个多签名钱包。

    Tiny熊
  • Asp.Net Web API中使用Session,Cache和Application的几个方法

        在ASP.NET中,Web Api的控制器类派生于ApiController,该类与ASP.NET的Control类没有直接关系,因此不能像在Web M...

    莫问今朝
  • 简约的JAVA版本MapReduce和日常No.25

    昨天做了一个小调查,说看看想看些啥。大概的分布是这样的,一个1代表一个投票。看来还是2、3比较多。 11111 希望看到"算法"回复1。 111...

    大蕉
  • Android仿微信语音消息的录制和播放功能

    长按Button时改变Button显示文字,弹出Dialog(动态更新音量),动态生成录音文件,开始录音;

    砸漏
  • PHP抽象类基本用法示例

    更多关于PHP相关内容感兴趣的读者可查看本站专题:《php面向对象程序设计入门教程》、《PHP数组(Array)操作技巧大全》、《PHP基本语法入门教程》、《P...

    砸漏
  • 前端开发:Vue封装一个公用的的Submit方法

    最近新学Vue,后台开发中经常用到提交,索性把提交功能给做成全局方法,下面为封装的代码。

    用户4831957
  • 一个根据双色球历史数据预测未来中奖号码的Java程序

    Jerry Wang
  • Android实现修改状态栏背景、字体和图标颜色的方法

    Android开发,对于状态栏的修改,实在是不友好,没什么api可以用,不像ios那么方便.但是ui又喜欢只搞ios一套.没办法.各种翻源码,写反射.真的蛋疼.

    砸漏

扫码关注云+社区

领取腾讯云代金券