求助: Go 代码注释貌似是某个插件生成的

beneo · 2024-9-5 13:06:23 · 185 次点击
大家好,我最近在学习使用 Go 语言进行后端开发,遇到了一个问题,希望能得到大家的帮助。
我在项目中看到了一些类似 Swagger 风格的注释,像这样:

```go
// @Tags App
// @Summary Page app installed
// @Description 分页获取已安装应用列表
// @Accept json
// @Param request body request.AppInstalledSearch true "request"
// @Success 200
// @Security ApiKeyAuth
// @Router /apps/installed/search [post]
```
请问 **这些注释是如何生成的?**是否有 IDE 插件可以自动补全这些注释?否则我在 IDE 里面太容易写不对这样的注释了
举报· 185 次点击
登录 注册 站外分享
16 条回复  
lrh3321 小成 2024-9-5 13:09:41
可以利用 vscode 的 snippets 来做
zoharSoul 小成 2024-9-5 13:15:24
手写的
ck65 小成 2024-9-5 13:18:40
复制粘贴改一改
falcon05 初学 2024-9-5 13:19:06
这些注释是用来生成 API 文档的,通常使用的是 Swagger (现在叫 OpenAPI )规范。在 Go 语言中,常用的工具是`swaggo/swag`。你可以通过安装这个工具来生成这些注释。

具体步骤如下:
1. 安装`swag`工具:在命令行中运行`go get -u github.com/swaggo/swag/cmd/swag`。
2. 在你的 Go 项目中运行`swag init`,这会根据你的代码生成注释。

至于 IDE 插件,JetBrains 的 GoLand IDE 有一个官方插件叫做“Goanno”,可以帮助你自动补全这些注释。如果你使用的是 VS Code ,也有一些插件如“Go for Visual Studio Code”可以提供类似的功能。
whitehack 小成 2024-9-5 13:28:19
@falcon05 #4  怎么一股 AI 的味道.
Ayanokouji 小成 2024-9-5 14:16:20
@beneo 我们项目都是手写的。。。
NX2023 小成 2024-9-5 14:25:27
@falcon05 #6 https://www.fshex.com/help/assertive
「请不要把 AI 生成的回复,当作你自己的回复,发到这里。」
ninjashixuan 小成 2024-9-5 14:28:25
如上面提到就是 swag 用来生成 swagger 文档的,当然不定全部手动,一些简单 curd 场景可以写脚本自动生成。
monkeyWie 小成 2024-9-5 14:30:24
就是手写的啊,go 的生态就是这样,毕竟官方不支持注解只能走歪门邪道了
12下一页
返回顶部