Solidity语言的代码规范 – 命名方式

为了避免混淆,下面的名字用来指明不同的命名方式。

  • b (单个小写字母)
  • B (单个大写字母)
  • lowercase (小写)
  • lower_case_with_underscores (小写和下划线)
  • UPPERCASE (大写)
  • UPPER_CASE_WITH_UNDERSCORES (大写和下划线)
  • CapitalizedWords (驼峰式,首字母大写)
  • mixedCase (混合式,与驼峰式的区别在于首字母小写!)
  • Capitalized_Words_With_Underscores (首字母大写和下划线)
..注意:: 当在驼峰式命名中使用缩写时,应该将缩写中的所有字母都大写。 因此 HTTPServerError 比 HttpServerError 好。
当在混合式命名中使用缩写时,除了第一个缩写中的字母小写(如果它是整个名称的开头的话)以外,其他缩写中的字母均大写。 因此 xmlHTTPRequest 比 XMLHTTPRequest 更好。

应避免的名称

  • l – el的小写方式
  • O – oh的大写方式
  • I – eye的大写方式

切勿将任何这些用于单个字母的变量名称。 他们经常难以与数字 1 和 0 区分开。

合约和库名称

合约和库名称应该使用驼峰式风格。比如:SimpleTokenSmartBankCertificateHashRepositoryPlayer

结构体名称

结构体名称应该使用驼峰式风格。比如:MyCoinPositionPositionXY

事件名称

事件名称应该使用驼峰式风格。比如:DepositTransferApprovalBeforeTransferAfterTransfer

函数名称

函数名称不同于结构,应该使用混合式命名风格。比如:getBalancetransferverifyOwneraddMemberchangeOwner

函数参数命名

函数参数命名应该使用混合式命名风格。比如:initialSupplyaccountrecipientAddresssenderAddressnewOwner。 在编写操作自定义结构的库函数时,这个结构体应该作为函数的第一个参数,并且应该始终命名为 self

局部变量和状态变量名称

使用混合式命名风格。比如:totalSupplyremainingSupplybalancesOfcreatorAddressisPreSaletokenExchangeRate

常量命名

常量应该全都使用大写字母书写,并用下划线分割单词。比如:MAX_BLOCKSTOKEN_NAMETOKEN_TICKERCONTRACT_VERSION

修饰符命名

使用混合式命名风格。比如:onlyByonlyAfteronlyDuringThePreSale

枚举变量命名

在声明简单类型时,枚举应该使用驼峰式风格。比如:TokenGroupFrameHashStyleCharacterLocation

避免命名冲突

  • single_trailing_underscore_

当所起名称与内建或保留关键字相冲突时,建议照此惯例在名称后边添加下划线。

发表评论

后才能评论