每一门语言都有其相应的编码规范, Solidity 也一样, 下面官方推荐的规范及我的总结,供大家参考,希望可以帮助大家写出更好规范的智能合约。
最新P3D新盘 chunchou.com
小写的l,大写的I,大写的O 应该避免在命名中单独出现,因为很容易产生混淆。
合约、库、事件及结构体命名应该使用单词首字母大写的方式,这个方式也称为:帕斯卡命名法或大驼峰式命名法,比如:SimpleToken, SmartBank, CertificateHashRepository,Player。
函数、参数、变量及修饰器应该使用首单词小写后面单词大写的方式,这个方式也称为:(小)驼峰式命名法,是一种混合大小写的方式,如:
使用空格(spaces)而不是Tab, 缩进应该是4个空格
合约之间应该有空行,例如:
|
|
而不是使用:
|
|
|
|
没有实现的话,空行可以省去,如:
|
|
而不是:
|
|
定义包括合约定义、函数定义、库定义、结构体定义等等,例如推荐使用:
|
|
而不是:
|
|
在使用if, else, while, for 时,推荐的写法是:
|
|
而不是:
|
|
如果控制语句内只有一行,括号可省略,如:
|
|
但像下面一个语句有多方就不能省略,如:
|
|
一个单行的表达里,在小括号、中括号、大括号里应该避免不必要的空格,例如推荐使用:
|
|
而不是:
1
spam( ham[ 1 ], Coin( { name: "ham" } ) );
有一种例外是,结尾的括号跟在结束的分号后面, 应该加一个空格,如下面的方式也是推荐的:
1
function singleLine() public { spam(); }
分号;前不应该有空格,例如推荐使用:
|
|
而不是:
1
function spam(uint i , Coin coin) public ;
不要为对齐添加不必要的空格,例如推荐使用:
|
|
而不是:
1
2
3
x = 1;
y = 2;
long_variable = 3;
回退函数不应该有空格,例如推荐使用:
|
|
每行不应该太长,最好在79(或99)个字符以内,函数的参数应该是单独的行,且只有一个缩进,例如推荐的方式是:
|
|
而不是:
|
|
对应的赋值语句应该是这样写:
|
|
而不是:
|
|
事件定义也应该遵循同样的原则,例如应该使用:
|
|
而不是:
|
|
推荐使用utf-8 及 ASCII 编码
建议使用:
|
|
而不是:
|
|
在编写函数的时候,应该让大家容易找到构造函数,回退函数,官方推荐的的函数顺序是:
同一类函数时,constant函数放在后面, 例如推荐方式为:
|
|
而不是下面的函数顺序:
|
|
所有的函数(包括构造函数)应该在定义的时候明确函数的可见性,例如应该使用:
|
|
而不是
|
|
函数的可见性应该写在自定义的函数修饰符前面,例如:
|
|
而不是
|
|
为了防止函数和事件(Event)产生混淆,声明一个事件使用大写并加入前缀(可使用LOG)。对于函数, 始终以小写字母开头,构造函数除外。
|
|
打个小广告,imtoken搜索HL,领取10万枚hotlove真爱链,可以在云加密交易所yunjiami.github.io/直接交易哦。
需要交流的朋友扫描二维码
常量应该使用全大写及下划线分割大词的方式,如:MAX_BLOCKS,TOKEN_NAME, CONTRACT_VERSION。
深入浅出区块链 - 系统学习区块链,打造最好的区块链技术博客。
如果你想和我有密切的联系,欢迎加入知识星球深入浅出区块链,我会在星球为大家解答技术问题,作为星友福利,星友可加入我创建的区块链技术群,群内已经聚集了200多位区块链技术牛人和爱好者。
360浏览器版MetaMask中文版下载地址
https://ext.se.360.cn/webstore/d ... jkmbmkibdhmklahopfi
360极速浏览器版MetaMask中文版下载地址
https://ext.chrome.360.cn/websto ... jkmbmkibdhmklahopfi
百度云下载地址
https://pan.baidu.com/s/17gPqvtGA_rF6ujwElZchgA
MetaMask中文版谷歌下载地址
https://chrome.google.com/websto ... D%E6%96%87?hl=zh-CN