关键词：
每一门语言都有其相应的编码规范， Solidity 也一样， 下面官方推荐的规范及我的总结，供大家参考，希望可以帮助大家写出更好规范的智能合约。命名规范
避免使用
小写的l，大写的I，大写的O 应该避免在命名中单独出现，因为很容易产生混淆。
合约、库、事件、枚举及结构体命名
合约、库、事件及结构体命名应该使用单词首字母大写的方式，这个方式也称为：帕斯卡命名法或大驼峰式命名法，比如：SimpleToken， SmartBank， CertificateHashRepository，Player。
函数、参数、变量及修饰器
函数、参数、变量及修饰器应该使用首单词小写后面单词大写的方式，这个方式也称为：（小）驼峰式命名法，是一种混合大小写的方式，如：
- 函数名应该如：getBalance，transfer，verifyOwner，addMember。
- 参数和变量应该如：initialSupply，senderAddress，account，isPreSale。
- 修饰器应该如：onlyAfter，onlyOwner。
代码格式相关
缩进
使用空格（spaces）而不是Tab, 缩进应该是4个空格
空行
合约之间应该有空行，例如：
contract A
...
contract B
...
contract C
...
而不是使用：
contract A
...
contract B
...
contract C
...
- 函数之间应该有空行，例如：
contract A
function spam() public
...
function ham() public
...
没有实现的话，空行可以省去，如：
contract A
function spam() public;
function ham() public;
而不是：
contract A
function spam() public
...
function ham() public
...
左括号应该跟定义在一行
定义包括合约定义、函数定义、库定义、结构体定义等等，例如推荐使用：
contract Coin
struct Bank
address owner;
uint balance;
而不是：
contract Coin
struct Bank
address owner;
uint balance;
左括号应该跟条件控制在一行
在使用if, else, while, for 时，推荐的写法是：
if (...)
...
for (...)
...
而不是：
if (...)
...
while(...)
for (...)
...;如果控制语句内只有一行，括号可省略，如：
if (x < 10)
x += 1;但像下面一个语句有多方就不能省略，如：
if (x < 10)
someArray.push(Coin(
name: ‘spam‘,
value: 42
));表达式内的空格
-
一个单行的表达里，在小括号、中括号、大括号里应该避免不必要的空格，例如推荐使用：
spam(ham[1], Coin(name: "ham"));而不是：
spam( ham[ 1 ], Coin( name: "ham" ) );有一种例外是，结尾的括号跟在结束的分号后面， 应该加一个空格，如下面的方式也是推荐的：
function singleLine() public spam(); -
分号；前不应该有空格，例如推荐使用：
function spam(uint i, Coin coin) public;而不是：
function spam(uint i , Coin coin) public ; -
不要为对齐添加不必要的空格，例如推荐使用：
x = 1; y = 2; long_variable = 3;而不是：
x = 1; y = 2; long_variable = 3; -
回退函数不应该有空格，例如推荐使用：
function() public ...而不是：
function () public ...
控制每一行长度
每行不应该太长，最好在79（或99）个字符以内，函数的参数应该是单独的行，且只有一个缩进，例如推荐的方式是：
thisFunctionCallIsReallyLong(
longArgument1,
longArgument2,
longArgument3
);而不是：
thisFunctionCallIsReallyLong(longArgument1,
longArgument2,
longArgument3
);
thisFunctionCallIsReallyLong(longArgument1,
longArgument2,
longArgument3
);
thisFunctionCallIsReallyLong(
longArgument1, longArgument2,
longArgument3
);
thisFunctionCallIsReallyLong(
longArgument1,
longArgument2,
longArgument3
);
thisFunctionCallIsReallyLong(
longArgument1,
longArgument2,
longArgument3);对应的赋值语句应该是这样写：
thisIsALongNestedMapping[being][set][to_some_value] = someFunction(
argument1,
argument2,
argument3,
argument4
);而不是：
thisIsALongNestedMapping[being][set][to_some_value] = someFunction(argument1,
argument2,
argument3,
argument4);事件定义也应该遵循同样的原则，例如应该使用：
event LongAndLotsOfArgs(
adress sender,
adress recipient,
uint256 publicKey,
uint256 amount,
bytes32[] options
);
LongAndLotsOfArgs(
sender,
recipient,
publicKey,
amount,
options
);而不是：
event LongAndLotsOfArgs(adress sender,
adress recipient,
uint256 publicKey,
uint256 amount,
bytes32[] options);
LongAndLotsOfArgs(sender,
recipient,
publicKey,
amount,
options);文件编码格式
推荐使用utf-8 及 ASCII 编码
引入文件应该在最上方
建议使用：
import "owned";
contract A
...
contract B is owned
...
而不是：
contract A
...
import "owned";
contract B is owned
...
函数编写规范
函数的顺序
在编写函数的时候，应该让大家容易找到构造函数，回退函数，官方推荐的的函数顺序是：
- 构造函数
- 回退函数 (如果有)
- 外部函数（external）
- 公有函数(public)
- 内部函数(internal)
- 私有函数（private）
同一类函数时，constant函数放在后面， 例如推荐方式为：
contract A
// 构造函数
function A() public
...
// 回退函数
function() public
...
// 外部函数
// ...
// 带有constant 外部函数
// ...
// 公有函数
// ...
// 内部函数
// ...
// 私有函数
// ...
而不是下面的函数顺序：
contract A
// 外部函数
// ...
// 公有函数
// ...
// 内部函数
// ...
function A() public
...
function() public
...
// 私有函数
// ...
明确函数的可见性
所有的函数（包括构造函数）应该在定义的时候明确函数的可见性，例如应该使用：
function explicitlyPublic(uint val) public
doSomething();
而不是
function implicitlyPublic(uint val)
doSomething();
可见性应该在修饰符前面
函数的可见性应该写在自定义的函数修饰符前面，例如：
function kill() public onlyowner
selfdestruct(owner);
而不是
function kill() onlyowner public
selfdestruct(owner);
区分函数和事件
为了防止函数和事件（Event）产生混淆，声明一个事件使用大写并加入前缀（可使用LOG）。对于函数， 始终以小写字母开头，构造函数除外。
// 不建议
event Transfer()
function transfer()
// 建议
event LogTransfer()
function transfer() external 常量
常量应该使用全大写及下划线分割大词的方式，如：MAX_BLOCKS，TOKEN_NAME， CONTRACT_VERSION。
参考文献
深入浅出区块链 - 系统学习区块链，打造最好的区块链技术博客。
区块链开发之solidity智能合约开发(代码片段)
在编写智能合约之前，需要有Solidity的开发环境，我将使用Remix来进行Solidity的学习，大家可以访问Remix在线Solidity集成开发环境其界面主要分三部分，左半本分是合约目录，可进行合约编译、发布右上部分是合... 查看详情
eos智能合约开发最佳实践(代码片段)
安全问题1.可能的错误智能合约终止限制转账限额限制速率有效途径来进行bug修复和提升2.谨慎发布智能合约对智能合约进行彻底的测试并在任何新的攻击手法被发现后及时制止赏金计划和审计合约3.合约的简介确保智能合约逻辑... 查看详情
solidity编程四之智能合约的结构
Solidity的智能合约和面向对象语言中的类很相似。每个智能合约可以包含的元素有：state变量的定义，方法，函数修改器，事件，结构类型以及枚举类型。同时合约可以继承于另外一个合约state变量 Solidity里的state变... 查看详情
区块链之智能合约solidity踩坑--上篇
...三个方面：对区块链的简单描述结合业务场景，编写简单智能合约，时遇到的坑(上篇)assembly的使用说明(下篇)正文进入正题之前，我稍微简单介绍一下什么是区块链，区块链干嘛用的(特点)，智能合约是做什么的，为什么要写只... 查看详情
区块链开发之solidity编程基础合约事件(代码片段)
事件事件智能合约返回值给用户接口异步的带数据的触发器一种比较便宜的存储事件里的Indexed参数事件事件是以太坊虚拟机（EVM）日志基础设施提供的一个便利接口。用于获取当前发生的事件。事件和日志有三个用途... 查看详情
solidity零基础入门solidity编写智能合约代码
...f0c;如果新手建议了解即可，以下是课程目录：1、智能合约概述2、区块链基础3、以太坊虚拟机4、安装Solidity编译器5、从源代码编译6、CMake参数7、版本号字符串详解8、版本信息详情9、实例学习Solidity10、秘密竞价（盲... 查看详情
第一行代码：以太坊-使用solidity语言开发和测试智能合约(代码片段)
智能合约是以太坊的核心之一，用户可以利用智能合约实现更灵活的代币以及其他DApp。不过在深入讲解如何开发智能合约之前，需要先介绍一下以太坊中用于开发智能合约的Solidity语言，以及相关的开发和测试环境。智能合约就... 查看详情
solidity：智能合约结构介绍(代码片段)
...声明。其中SPDX-License-Identifier(SPDX许可标示)是标注当前的智能合约采用什么样的对外开放标准，该标准规定了别人是否拥有商业开发，学习使用等权利。代码中使用的MIT规定了其他人随便用该代码，但出问题不负责。M... 查看详情
智能合约语言solidity教程系列5-数组介绍(代码片段)
...的文章列表请查看分类-Solidity。写在前面Solidity是以太坊智能合约编程语言，阅读本文前，你应该对以太坊、智能合约有所了解，如果你还不了解，建议你先看以太坊是什么本文前半部分是参考Solidity官方文档（当前最新版本：0.... 查看详情
智能合约语言solidity教程系列3-函数类型(代码片段)
...的文章列表请查看分类-Solidity。写在前面Solidity是以太坊智能合约编程语言，阅读本文前，你应该对以太坊、智能合约有所了解，如果你还不了解，建议你先看以太坊是什么本文前半部分是参考Solidity官方文档（当前最新版本：0.... 查看详情
solidity开发以太坊代币智能合约(代码片段)
智能合约开发是以太坊编程的核心之一，而代币是区块链应用的关键环节，下面我们来用solidity语言开发一个代币合约的实例，希望对大家有帮助。以太坊的应用被称为去中心化应用（DApp），DApp的开发主要包括两大部分：智能... 查看详情
开发 Solidity 的最佳 IDE / 插件
...18-12-0715:25:42【问题描述】：我正在开发一些复杂的Solidity智能合约（使用一些外部库，例如Oraclize）。我的想法是我目前使用的IDERemix和OraclizeIDE不符合我想要的要求，我需要：编译、部署和测试可以使用Oraclize库的智能合约将文... 查看详情
区块链开发之solidity编程基础(代码片段)
Solidy是当前编写智能合约的主流语言概要sol文件结构编译开发引入其他文件注释代码注释文档注释合约状态变量类型值类型概要由ETH为代表的第二代区块链技术，相比于第一代区块链技术而言，最大的特点就是智能合约... 查看详情
智能合约从入门到精通：用solidity开发一个“helloworld”(代码片段)
简介：上一章中我们聊到了智能合约的应用场景，在了解区块链技术目前的发展情况、智能合约的概念以及其应用场景之后，我们将在后续的文章中共同学习智能合约的编成语言。今天，我们就来简单地谈一谈用于编写智能合约... 查看详情
如何调用 Solidity 函数从智能合约中返回以太币？
】如何调用Solidity函数从智能合约中返回以太币？【英文标题】：HowtocallSolidityFunctiontoreturnEtherfromSmartContract?【发布时间】：2021-09-0223:26:46【问题描述】：我已经在本地truffle项目上部署了一个智能合约，我正在尝试在一个使用web3... 查看详情
0基础学习solidity开发智能合约-初识solidity(代码片段)
本篇课程开始，我们来学习一下如何使用solidity开发智能合约，由于博主对于solidity的学习，也是自学的，所以一些不足或有纰漏之处还望指出，大家共同进步，本系列课程会分很多节课讲述，从入门到... 查看详情
智能合约语言solidity教程系列9-错误处理(代码片段)
...请扫描下面的二维码查看。 写在前面Solidity是以太坊智能合约编程语言，阅读本文前，你应该对以太坊、智能合约有所了解，如果你还不了解，建议你先看以太坊是什么欢迎订阅区块链技术专栏阅读更全面的分析文章。什么... 查看详情
智能合约语言solidity教程系列1-类型介绍(代码片段)
...的都比它好，大家还是别看了。写在前面Solidity是以太坊智能合约编程语言，阅读本文前，你应该对以太坊、智能合约有所了解，如果你还不了解，建议你先看以太坊是什么Solidity教程会是一系列文章，本文是第一篇：介绍Solidity... 查看详情