今日はSolidityにおけるコメントの書き方について解説していきます。
コメントのシンタックス
Solidityにも他言語と同じようにコメントが存在します。
元々、SolidityはJavaScriptに似ている言語なので、コメントの記入方法も同じです。
各関数に記載すべきコメントの書き方
Solidityの場合、Contractやfunctionに対し、それぞれを説明するコメントを記載する必要があります。
Solidityのコミュニティにおいては、netspecというフォーマットを用いることがスタンダードとなっていて、以下のような形になります。
すべてのタグは記載自由となっていますが、最低でも@devで各関数の働きを説明するのが通例となっています。
| @title | コントラクトや関数のタイトルを記載 |
|---|---|
| @author | 作成者を記載 |
| @notice | コントラクトや関数が何をするのかを説明 |
| @param | パラメータの説明 |
| @return | 返り値の説明 |
| @dev | 開発者向けに@noticeよりも詳細な説明 |