solidity编码规范

本文详细介绍了Solidity的编码规范,包括命名规范如驼峰式命名,代码格式相关如缩进、空行、括号对齐,以及函数编写规范和变量声明等,旨在提升合约代码的可读性和一致性。
摘要由CSDN通过智能技术生成

命名规范

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

当文件里只包含一个合约时,文件命名应该与合约命名相同。
当文件里包含不只一个合约时,文件命名应该根据项目内容合理命名。

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

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

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

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

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

修饰器应该如:onlyAfter,onlyOwner。

代码格式相关

缩进

在方法、变量或者机构体等每行使用0、2或者4个空格缩进

在tab或空格的选择中,空格是首选缩进方式,禁止tab和空格混合使用。

空行

回车(空行)

不同的功能块之间应该用空格隔开,例如公共变量与方法之间,方法与方法之间等,且不允许使用连续的空行。(只能用一个空行,不同的代码块或者功能应使用注释加空行)

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

  contract A {
      ...
  }

  contract B {
      ...
  }

  contract C {
      ...
  }

而不是使用:

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

  contract C {
      ...
  }

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

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值
>