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

汇新云】为大家定期更新文章,【汇新云】IT人的产业链平台

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

命名规范

避免使用

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

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

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

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

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

函数名应该如:getBalance,transfer,verifyOwner,addMember。

参数和变量应该如:initialSupply,senderAddress,account,isPreSale。

修饰器应该如:onlyAfter,onlyOwner。

代码格式相关

缩进

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

空行

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

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

而不是使用:

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

。函数之间应该有空行,例如:

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

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

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

而不是:

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

左括号应该跟定义在一行

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

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

而不是:

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

左括号应该跟条件控制在一行

在使用if, else, while, for 时,推荐的写法是:

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

而不是:

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

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

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

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

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

表达式内的空格

。一个单行的表达里,在小括号、中括号、大括号里应该避免不必要的空格,例如推荐使用:

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

而不是:

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

有一种例外是,结尾的括号跟在结束的分号后面, 应该加一个空格,如下面的方式也是推荐的:

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

分号;前不应该有空格,例如推荐使用:

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

而不是:

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

不要为对齐添加不必要的空格,例如推荐使用:

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

而不是:

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

。回退函数不应该有空格,例如推荐使用:

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

控制每一行长度

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

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

而不是:

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

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

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

而不是:

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

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

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

而不是:

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

文件编码格式

推荐使用utf-8 及 ASCII 编码

引入文件应该在最上方

建议使用:

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

而不是:

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

函数编写规范

函数的顺序

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

构造函数

回退函数 (如果有)

外部函数(external)

公有函数(public)

内部函数(internal)

私有函数(private)

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

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

而不是下面的函数顺序:

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

明确函数的可见性

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

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

而不是

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

可见性应该在修饰符前面

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

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

而不是

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

区分函数和事件

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

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

常量

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

参考文献

Solidity style-guide

学好区块链,拥抱新未来:

区块链产品经理(点击入驻),和圈内人士混个脸熟

    原文作者:创成汇之眼
    原文地址: https://www.jianshu.com/p/d616f387d811
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞