今天开始分享 Solidity 编码规范,昨晚就把视频上传到了B站,今早又同步到了视频号。
首先,为什么需要编码规范,主要有几方面原因:
提高代码可读性
促进团队协作
减少错误
提高维护性
有助于代码审查
提高代码质量
遵循行业标准
接下来开始讲 Solidity 层面具体的编码规范和最佳实践。
先是介绍下文件命名,总结为四点:
采用大驼峰式命名法
与合约组件名保持一致
每个文件里只定义一个合约组件
interface命名额外添加大写 I 作为前缀
之后讲了下关于文件编排的一些建议,即不同类型的多个文件可归类到不同的文件夹下,比如,多个 interface 类型的文件可存放在 interfaces 文件夹下,多个 library 类型的文件可存放在 libraries 文件夹下,多个抽象合约可存于 base 或 utils 目录下,需要部署的主合约则通常放在 contracts 根目录下。
视频中还举了很多实际的例子,大家可以去观看视频,会有更直观的理解。