【Solidity】コメントの書き方（natspec）

Solidityでのコメントはnatspecと呼ばれるフォーマットを用いることがスタンダードとなっている。

なかなか覚えられないので、備忘録としてコメントの書き方を記載しておきます。

/// @title コントラクトのタイトル
/// @author 作成者の名前
/// @notice このコントラクトの説明（どのような処理を行うかなど）
/// @dev このコントラクトの開発者向けの更なる詳細な説明
contract Calculate {
  /// @author 作成者の名前
  /// @notice この関数の説明
  /// @param パラメータの説明（パラメータ数分記載する）
  /// @return 戻り値の説明
  /// @dev この関数の開発者向けの更なる詳細な説明
  function add(uint x, uint y) returns (uint z) {
    z = x + y;
  }
}

全てのコントラクト、関数にこれらのタグを記載しなければならないというわけではない。
しかし、保守性を考えると@devだけは書いておきたい。

参考