注釋
Solidity 里的注釋和 JavaScript 相同按傅。在我們的課程中你已經(jīng)看到了不少單行注釋了：
// 這是一個(gè)單行注釋捉超，可以理解為給自己或者別人看的筆記
/*
這是多行注釋
*/
Solidity 社區(qū)所使用的一個(gè)標(biāo)準(zhǔn)是使用一種被稱作 natspec 的格式，看起來像這樣：
/// @title 一個(gè)簡單的基礎(chǔ)運(yùn)算合約
/// @author 童蒙_
/// @notice 現(xiàn)在唯绍，這個(gè)合約只添加一個(gè)乘法
contract Math {
/// @notice 兩個(gè)數(shù)相乘
/// @param x 第一個(gè) uint
/// @param y 第二個(gè) uint
/// @return z (x * y) 的結(jié)果
/// @dev 現(xiàn)在這個(gè)方法不檢查溢出
function multiply(uint x, uint y) returns (uint z) {
// 這只是個(gè)普通的注釋，不會(huì)被 natspec 解釋
z = x * y;
}
}
@title（標(biāo)題） 和@author（作者）很直接了.@notice（須知）向 用戶 解釋這個(gè)方法或者合約是做什么的枝誊。@dev（開發(fā)者） 是向開發(fā)者解釋更多的細(xì)節(jié)况芒。@param（參數(shù)）和@return（返回） 用來描述這個(gè)方法需要傳入什么參數(shù)以及返回什么值。
注意你并不需要每次都用上所有的標(biāo)簽叶撒，它們都是可選的绝骚。不過最少，寫下一個(gè)
@dev注釋來解釋每個(gè)方法是做什么的祠够。
