最新內(nèi)容會(huì)更新在主站深入淺出區(qū)塊鏈社區(qū)
原文鏈接:智能合約最佳實(shí)踐 之 Solidity 編碼規(guī)范
每一門語言都有其相應(yīng)的編碼規(guī)范缀程， Solidity 也一樣妻坝， 下面官方推薦的規(guī)范及我的總結(jié)，供大家參考铣鹏，希望可以幫助大家寫出更好規(guī)范的智能合約敷扫。
命名規(guī)范
避免使用
小寫的l，大寫的I诚卸，大寫的O 應(yīng)該避免在命名中單獨(dú)出現(xiàn)葵第，因?yàn)楹苋菀桩a(chǎn)生混淆绘迁。
合約、庫卒密、事件缀台、枚舉及結(jié)構(gòu)體命名
合約、庫哮奇、事件及結(jié)構(gòu)體命名應(yīng)該使用單詞首字母大寫的方式膛腐，這個(gè)方式也稱為：帕斯卡命名法或大駝峰式命名法，比如：SimpleToken鼎俘， SmartBank依疼， CertificateHashRepository，Player而芥。
函數(shù)律罢、參數(shù)、變量及修飾器
函數(shù)棍丐、參數(shù)误辑、變量及修飾器應(yīng)該使用首單詞小寫后面單詞大寫的方式，這個(gè)方式也稱為：（懈璺辍）駝峰式命名法巾钉，是一種混合大小寫的方式，如：
- 函數(shù)名應(yīng)該如：getBalance秘案，transfer砰苍，verifyOwner，addMember阱高。
- 參數(shù)和變量應(yīng)該如：initialSupply赚导，senderAddress，account赤惊，isPreSale吼旧。
- 修飾器應(yīng)該如：onlyAfter，onlyOwner未舟。
代碼格式相關(guān)
縮進(jìn)
使用空格（spaces）而不是Tab, 縮進(jìn)應(yīng)該是4個(gè)空格
空行
合約之間應(yīng)該有空行圈暗，例如：
contract A {
...
}
contract B {
...
}
contract C {
...
}
而不是使用：
contract A {
...
}
contract B {
...
}
contract C {
...
}
- 函數(shù)之間應(yīng)該有空行，例如：
contract A {
function spam() public {
...
}
function ham() public {
...
}
}
沒有實(shí)現(xiàn)的話裕膀，空行可以省去员串，如：
contract A {
function spam() public;
function ham() public;
}
而不是：
contract A {
function spam() public {
...
}
function ham() public {
...
}
}
左括號(hào)應(yīng)該跟定義在一行
定義包括合約定義、函數(shù)定義昼扛、庫定義寸齐、結(jié)構(gòu)體定義等等，例如推薦使用：
contract Coin {
struct Bank {
address owner;
uint balance;
}
}
而不是：
contract Coin
{
struct Bank {
address owner;
uint balance;
}
}
左括號(hào)應(yīng)該跟條件控制在一行
在使用if, else, while, for 時(shí)，推薦的寫法是：
if (...) {
...
}
for (...) {
...
}
而不是：
if (...)
{
...
}
while(...){
}
for (...) {
...;}
如果控制語句內(nèi)只有一行访忿，括號(hào)可省略瞧栗，如：
if (x < 10)
x += 1;
但像下面一個(gè)語句有多方就不能省略，如：
if (x < 10)
someArray.push(Coin({
name: 'spam',
value: 42
}));
表達(dá)式內(nèi)的空格
-
一個(gè)單行的表達(dá)里海铆，在小括號(hào)迹恐、中括號(hào)、大括號(hào)里應(yīng)該避免不必要的空格卧斟，例如推薦使用：
spam(ham[1], Coin({name: "ham"}));而不是：
spam( ham[ 1 ], Coin( { name: "ham" } ) );有一種例外是殴边，結(jié)尾的括號(hào)跟在結(jié)束的分號(hào)后面， 應(yīng)該加一個(gè)空格珍语，如下面的方式也是推薦的：
function singleLine() public { spam(); } -
分號(hào)锤岸；前不應(yīng)該有空格，例如推薦使用：
function spam(uint i, Coin coin) public;而不是：
function spam(uint i , Coin coin) public ; -
不要為對(duì)齊添加不必要的空格板乙，例如推薦使用：
x = 1; y = 2; long_variable = 3;而不是：
x = 1; y = 2; long_variable = 3; -
回退函數(shù)不應(yīng)該有空格是偷，例如推薦使用：
function() public { ... }而不是：
function () public { ... }
控制每一行長度
每行不應(yīng)該太長，最好在79（或99）個(gè)字符以內(nèi)募逞，函數(shù)的參數(shù)應(yīng)該是單獨(dú)的行蛋铆，且只有一個(gè)縮進(jìn)，例如推薦的方式是：
thisFunctionCallIsReallyLong(
longArgument1,
longArgument2,
longArgument3
);
而不是：
thisFunctionCallIsReallyLong(longArgument1,
longArgument2,
longArgument3
);
thisFunctionCallIsReallyLong(longArgument1,
longArgument2,
longArgument3
);
thisFunctionCallIsReallyLong(
longArgument1, longArgument2,
longArgument3
);
thisFunctionCallIsReallyLong(
longArgument1,
longArgument2,
longArgument3
);
thisFunctionCallIsReallyLong(
longArgument1,
longArgument2,
longArgument3);
對(duì)應(yīng)的賦值語句應(yīng)該是這樣寫：
thisIsALongNestedMapping[being][set][to_some_value] = someFunction(
argument1,
argument2,
argument3,
argument4
);
而不是：
thisIsALongNestedMapping[being][set][to_some_value] = someFunction(argument1,
argument2,
argument3,
argument4);
事件定義也應(yīng)該遵循同樣的原則放接，例如應(yīng)該使用：
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 編碼
引入文件應(yīng)該在最上方
建議使用：
import "owned";
contract A {
...
}
contract B is owned {
...
}
而不是：
contract A {
...
}
import "owned";
contract B is owned {
...
}
函數(shù)編寫規(guī)范
函數(shù)的順序
在編寫函數(shù)的時(shí)候刺啦，應(yīng)該讓大家容易找到構(gòu)造函數(shù)，回退函數(shù)纠脾，官方推薦的的函數(shù)順序是：
- 構(gòu)造函數(shù)
- 回退函數(shù) (如果有)
- 外部函數(shù)（external）
- 公有函數(shù)(public)
- 內(nèi)部函數(shù)(internal)
- 私有函數(shù)（private）
同一類函數(shù)時(shí)玛瘸，constant函數(shù)放在后面， 例如推薦方式為：
contract A {
// 構(gòu)造函數(shù)
function A() public {
...
}
// 回退函數(shù)
function() public {
...
}
// 外部函數(shù)
// ...
// 帶有constant 外部函數(shù)
// ...
// 公有函數(shù)
// ...
// 內(nèi)部函數(shù)
// ...
// 私有函數(shù)
// ...
}
而不是下面的函數(shù)順序：
contract A {
// 外部函數(shù)
// ...
// 公有函數(shù)
// ...
// 內(nèi)部函數(shù)
// ...
function A() public {
...
}
function() public {
...
}
// 私有函數(shù)
// ...
}
明確函數(shù)的可見性
所有的函數(shù)（包括構(gòu)造函數(shù)）應(yīng)該在定義的時(shí)候明確函數(shù)的可見性苟蹈，例如應(yīng)該使用：
function explicitlyPublic(uint val) public {
doSomething();
}
而不是
function implicitlyPublic(uint val) {
doSomething();
}
可見性應(yīng)該在修飾符前面
函數(shù)的可見性應(yīng)該寫在自定義的函數(shù)修飾符前面糊渊，例如：
function kill() public onlyowner {
selfdestruct(owner);
}
而不是
function kill() onlyowner public {
selfdestruct(owner);
}
區(qū)分函數(shù)和事件
為了防止函數(shù)和事件（Event）產(chǎn)生混淆，聲明一個(gè)事件使用大寫并加入前綴（可使用LOG）汉操。對(duì)于函數(shù)再来， 始終以小寫字母開頭，構(gòu)造函數(shù)除外磷瘤。
// 不建議
event Transfer() {}
function transfer() {}
// 建議
event LogTransfer() {}
function transfer() external {}
常量
常量應(yīng)該使用全大寫及下劃線分割大詞的方式，如：MAX_BLOCKS搜变，TOKEN_NAME采缚， CONTRACT_VERSION。
參考視頻
我們也推出了目前市面上最全的視頻教程：深入詳解以太坊智能合約語言Solidity
目前我們也在招募體驗(yàn)師挠他，可以點(diǎn)擊鏈接了解扳抽。
