每一门语言都有其相应的编码规范, Solidity 也一样, 下面官方推荐的规范及我的总结,供大家参考,希望可以帮助大家写出更好规范的智能合约。
命名规范
避免使用
小写的l,大写的I,大写的O 应该避免在命名中单独出现,因为很容易产生混淆。
合约、库、事件、枚举及结构体命名
合约、库、事件及结构体命名应该使用单词首字母大写的方式,这个方式也称为:帕斯卡命名法或大驼峰式命名法,比如:SimpleToken, SmartBank, CertificateHashRepository,Player。
函数、参数、变量及修饰器
函数、参数、变量及修饰器应该使用首单词小写后面单词大写的方式,这个方式也称为:(小)驼峰式命名法,是一种混合大小写的方式,如:
函数名应该如:getBalance,transfer,verifyOwner,addMember。
参数和变量应该如:initialSupply,senderAddress,account,isPreSale。
修饰器应该如:onlyAfter,onlyOwner。
代码格式相关
缩进
使用空格(spaces)而不是Tab, 缩进应该是4个空格
空行
合约之间应该有空行,例如:
![](https://i-blog.csdnimg.cn/blog_migrate/95e85b55c864bd3f4c4a78b16472c2c1.webp?x-image-process=image/format,png)
而不是使用:
![](https://i-blog.csdnimg.cn/blog_migrate/5001e8d4f655c1c7e065136bdd866723.webp?x-image-process=image/format,png)
。函数之间应该有空行,例如:
![](https://i-blog.csdnimg.cn/blog_migrate/97d2d0954daf277bd236a26c5c17b14d.webp?x-image-process=image/format,png)
没有实现的话,空行可以省去,如:
![](https://i-blog.csdnimg.cn/blog_migrate/6393aac361c08c192690c9dd950c02ce.webp?x-image-process=image/format,png)
而不是:
![](https://i-blog.csdnimg.cn/blog_migrate/292619d540d8e564326de15a26738a16.webp?x-image-process=image/format,png)
左括号应该跟定义在一行
定义包括合约定义、函数定义、库定义、结构体定义等等,例如推荐使用:
![](https://i-blog.csdnimg.cn/blog_migrate/15f8df128042d227b96cdfec6df7fe4a.webp?x-image-process=image/format,png)
而不是:
![](https://i-blog.csdnimg.cn/blog_migrate/2172b1e60748e4eea49f0aecc7c9717f.webp?x-image-process=image/format,png)
左括号应该跟条件控制在一行
在使用if, else, while, for 时,推荐的写法是:
![](https://i-blog.csdnimg.cn/blog_migrate/2d946ed47be27075deb5e7a2699f7805.webp?x-image-process=image/format,png)
而不是:
![](https://i-blog.csdnimg.cn/blog_migrate/22c1a3b1819244377a160b2a56e51111.webp?x-image-process=image/format,png)
如果控制语句内只有一行,括号可省略,如:
![](https://i-blog.csdnimg.cn/blog_migrate/a84940b927214a8e4ee48c94e09ba61b.webp?x-image-process=image/format,png)
但像下面一个语句有多方就不能省略,如:
![](https://i-blog.csdnimg.cn/blog_migrate/edee6e5586e73e3f6c95af9008a3558c.webp?x-image-process=image/format,png)
表达式内的空格
。一个单行的表达里,在小括号、中括号、大括号里应该避免不必要的空格,例如推荐使用:
![](https://i-blog.csdnimg.cn/blog_migrate/923a7c7a36d5af865decfe4ae43081d5.webp?x-image-process=image/format,png)
而不是:
![](https://i-blog.csdnimg.cn/blog_migrate/25f2ad9c06cca8ef5d2fef279679de45.webp?x-image-process=image/format,png)
有一种例外是,结尾的括号跟在结束的分号后面, 应该加一个空格,如下面的方式也是推荐的:
![](https://i-blog.csdnimg.cn/blog_migrate/ccd27ba78d68bbeda741bdcb9996f172.webp?x-image-process=image/format,png)
分号;前不应该有空格,例如推荐使用:
![](https://i-blog.csdnimg.cn/blog_migrate/6e9376008e518a83af449b5f57019698.webp?x-image-process=image/format,png)
而不是:
![](https://i-blog.csdnimg.cn/blog_migrate/9f2c93454a6a44d56fdda88587a6dbf5.webp?x-image-process=image/format,png)
不要为对齐添加不必要的空格,例如推荐使用:
![](https://i-blog.csdnimg.cn/blog_migrate/a6ca93a170257c70208b1d0cc46bf778.webp?x-image-process=image/format,png)
而不是:
![](https://i-blog.csdnimg.cn/blog_migrate/3271b28b9104d3e4ed14ec4571663979.webp?x-image-process=image/format,png)
。回退函数不应该有空格,例如推荐使用:
![](https://i-blog.csdnimg.cn/blog_migrate/7d9c710cbdd6f0cd4dfe014689de470f.webp?x-image-process=image/format,png)
控制每一行长度
每行不应该太长,最好在79(或99)个字符以内,函数的参数应该是单独的行,且只有一个缩进,例如推荐的方式是:
![](https://i-blog.csdnimg.cn/blog_migrate/6c91f3f22ec9873de0500e60a45ed481.webp?x-image-process=image/format,png)
而不是:
![](https://i-blog.csdnimg.cn/blog_migrate/8b5a726c125cd33385873a06623cbcf4.webp?x-image-process=image/format,png)
对应的赋值语句应该是这样写:
![](https://i-blog.csdnimg.cn/blog_migrate/6d7d7b15a7355bcac130dd38069dff06.webp?x-image-process=image/format,png)
而不是:
![](https://i-blog.csdnimg.cn/blog_migrate/8301d8559857636aa5785cd5e12aa5ac.webp?x-image-process=image/format,png)
事件定义也应该遵循同样的原则,例如应该使用:
![](https://i-blog.csdnimg.cn/blog_migrate/83bf8e2b40acccb5027fa9263656092f.webp?x-image-process=image/format,png)
而不是:
![](https://i-blog.csdnimg.cn/blog_migrate/3b9fbf719a1ce099851be71c094a9535.webp?x-image-process=image/format,png)
文件编码格式
推荐使用utf-8 及 ASCII 编码
引入文件应该在最上方
建议使用:
![](https://i-blog.csdnimg.cn/blog_migrate/f443050d92aa74bd34ac5e70a318e850.webp?x-image-process=image/format,png)
而不是:
![](https://i-blog.csdnimg.cn/blog_migrate/150b0b6f02c9b81fe9307adf0f5618ab.webp?x-image-process=image/format,png)
函数编写规范
函数的顺序
在编写函数的时候,应该让大家容易找到构造函数,回退函数,官方推荐的的函数顺序是:
构造函数
回退函数 (如果有)
外部函数(external)
公有函数(public)
内部函数(internal)
私有函数(private)
同一类函数时,constant函数放在后面, 例如推荐方式为:
![](https://i-blog.csdnimg.cn/blog_migrate/feb1d5540945a60bf85c2ad8840abfb2.webp?x-image-process=image/format,png)
而不是下面的函数顺序:
![](https://i-blog.csdnimg.cn/blog_migrate/ef79ae0d8dcd37d18f39aae866d50198.webp?x-image-process=image/format,png)
明确函数的可见性
所有的函数(包括构造函数)应该在定义的时候明确函数的可见性,例如应该使用:
![](https://i-blog.csdnimg.cn/blog_migrate/0ad8e9ef46b2641ba9fbcabfbea1d273.webp?x-image-process=image/format,png)
而不是
![](https://i-blog.csdnimg.cn/blog_migrate/943033dbfa5e87058d0a6c78cba33505.webp?x-image-process=image/format,png)
可见性应该在修饰符前面
函数的可见性应该写在自定义的函数修饰符前面,例如:
![](https://i-blog.csdnimg.cn/blog_migrate/78d09a0f457bad5994ebd362524c4680.webp?x-image-process=image/format,png)
而不是
![](https://i-blog.csdnimg.cn/blog_migrate/663f337d1225a46f7d078d12be36c47b.webp?x-image-process=image/format,png)
区分函数和事件
为了防止函数和事件(Event)产生混淆,声明一个事件使用大写并加入前缀(可使用LOG)。对于函数, 始终以小写字母开头,构造函数除外。
![](https://i-blog.csdnimg.cn/blog_migrate/cd85fe4c86e7149275858fb5a85d7f19.webp?x-image-process=image/format,png)
常量
常量应该使用全大写及下划线分割大词的方式,如:MAX_BLOCKS,TOKEN_NAME, CONTRACT_VERSION。
参考文献
学好区块链,拥抱新未来:
区块链产品经理(点击入驻),和圈内人士混个脸熟。