在Golang项目中,函数方法写注释,是一项必不可少的事情。根据代码注释生成文档的库有不少,在这里,我们项目使用的是Swagger
。在使用它生成注释的时候,提示错误:ParseComment error in file XXXXXX :missing required param comment parameters "opUid 操作uid" exit status 1
。 代码注释如下:
执行swagger init
后,提示报错如下:
Swagger
是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful
风格的 Web
服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法、参数和模型紧密集成到服务器端的代码,允许 API
来始终保持同步。Swagger
让部署管理和使用功能强大的 API 从未如此简单。