solidity 合约开发测试3--NatSpec注释(hardhat)

1. 安装solidity-docgen

2. 写注释

3. 运行 hardhat docgen

会在项目中生成docs文件夹，包含一个index.md

具体注释文档地址：https://docs.soliditylang.org/en/v0.8.17/natspec-format.html

对合约注释

/// @notice 合约描述
/// @dev 开发信息
contract Relation {
}

对方法的注释

/// @param ads 要绑定的地址
function bind(address ads) public {
}

/// @notice 注释
/// @return 返回信息1
/// @return 返回信息2
function inviteInfo() public view returns (address,bool,uint,address[] memory) {
几个返回值就要写几个 /// @return
}
©著作权归作者所有,转载或内容合作请联系作者
平台声明：文章内容（如有图片或视频亦包括在内）由作者上传并发布，文章内容仅代表作者本人观点，简书系信息发布平台，仅提供信息存储服务。

推荐阅读更多精彩内容