Solidity注释格式

• 注释

Solidity 里的注释和 JavaScript 相同。在我们的课程中你已经看到了不少单行注释了：

// 这是一个单行注释，可以理解为给自己或者别人看的笔记

/*
  这是多行注释
*/

Solidity 社区所使用的一个标准是使用一种被称作 natspec 的格式，看起来像这样：

/// @title 一个简单的基础运算合约
/// @author 童蒙_
/// @notice 现在，这个合约只添加一个乘法
contract Math {
  /// @notice 两个数相乘
  /// @param x 第一个 uint
  /// @param y  第二个 uint
  /// @return z  (x * y) 的结果
  /// @dev 现在这个方法不检查溢出
  function multiply(uint x, uint y) returns (uint z) {
    // 这只是个普通的注释，不会被 natspec 解释
    z = x * y;
  }
}

@title（标题） 和 @author（作者）很直接了.

@notice （须知）向 用户 解释这个方法或者合约是做什么的。

@dev（开发者） 是向开发者解释更多的细节。

@param（参数）和 @return （返回） 用来描述这个方法需要传入什么参数以及返回什么值。

注意你并不需要每次都用上所有的标签，它们都是可选的。不过最少，写下一个 @dev 注释来解释每个方法是做什么的。