zl程序教程

您现在的位置是:首页 >  其他

当前栏目

solidity注解标签

2023-04-18 15:26:46 时间

在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

 

注解标签在开发的过程中是非常有必要的