WeBase中 `@brief` 报错解决办法

128 阅读1分钟

当你按照WeBase官方文档使用Table系列声明合约时,你可能会收获如下报错

DocstringParsingError: Doc tag @brief not valid for functions.

解决方法是删除合约中所有的的如下注释

    /**
     * @brief xxx
     * @param xxx
     * @return xxx
     */

上述代码片段中的三行分别是 Solidity 中的注释格式,用于解释代码的作用、参数和返回值。具体含义如下:

  • * @brief xxx: 用于简要描述当前函数或代码块的作用。
  • * @param xxx: 用于描述当前函数或代码块中的参数,指定参数名称和类型,并提供有关其用途和限制的说明。
  • * @return xxx: 用于描述当前函数或代码块的返回值类型和意义。

在 Solidity 中,注释不会影响代码的运行结果,但是可以提高代码的可读性和可维护性。特别是在 Solidity 合约中,注释对于其他开发人员更好地理解代码的作用、调用方式、参数和返回值等信息非常有用。

所以按理来说,@brief并不应该影响编译,但是我也不知道为什么,WeBase貌似不能解析@brief的存在,报错正是由@brief注释造成,删除即可,你可以删除全部注释,也可以只删除@brief而保留@param@param,总之只要你的代码中没有@brief就能解决问题