1. 安裝solidity-docgen
2. 寫(xiě)注釋
3. 運(yùn)行 hardhat docgen
會(huì)在項(xiàng)目中生成docs文件夾，包含一個(gè)index.md
具體注釋文檔地址：https://docs.soliditylang.org/en/v0.8.17/natspec-format.html
對(duì)合約注釋
/// @notice 合約描述
/// @dev 開(kāi)發(fā)信息
contract Relation {
}
對(duì)方法的注釋
/// @param ads 要綁定的地址
function bind(address ads) public {
}
/// @notice 注釋
/// @return 返回信息1
/// @return 返回信息2
function inviteInfo() public view returns (address,bool,uint,address[] memory) {
幾個(gè)返回值就要寫(xiě)幾個(gè) /// @return
}
