在solidity語言中
註釋符為//
註解符為/* 內容*/ 或者 是 ///內容 註解中含有這幾個標籤給予我們使用
@title |
一個應該描述合約/介面的標題
|
contract, library, interface
|
@author |
作者的名字
|
contract, library, interface
|
@notice |
向終端使用者解釋這個東西的作用
|
contract, library, interface, function, public state variable, event
|
@dev |
向開發人員解釋任何額外的細節
|
contract, library, interface, function, state variable, event
|
@param |
就像在Doxygen中一樣記錄一個引數（必須在引數名之後）
|
function, event
|
@return |
記錄一個合約的函式的返回變數
|
function, public state variable
|
@inheritdoc |
從基本函式中複製所有缺失的標籤（必須在合約名稱之後）
|
function, public state variable
|
@custom:... |
自定義標籤，語義由應用程式定義
|
everywhere
|
註解標籤在開發的過程中是非常有必要的