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

beneo · 2024-9-5 13:06:23 · 262 次点击
大家好,我最近在学习使用 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 里面太容易写不对这样的注释了
举报· 262 次点击
登录 注册 站外分享
16 条回复  
Desdemor 小成 2024-9-6 09:59:23

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

手写的,然后 swag 根据手写的注释生成接口文档或者导入到 apifox 里
DefoliationM 小成 2024-9-5 18:20:13
手写的
clf 小成 2024-9-5 17:00:58
我倒是 IDEA 给自己团队写了一个接口文档生成插件。

自动遍历深层的代码注释作为接口字段说明的值,如果没注释,先找同代码文件的同字段注释(一般一组 API 都是一个业务的),如果还没有找插件内置字典,还没有就留空。
wangritian 小成 2024-9-5 16:48:37
我是找个类似的接口复制改一下
wzdsfl 小成 2024-9-5 15:25:04
@falcon05 #4 这位网友,你也不想你的回复被举报吧
xiaozirun 小成 2024-9-5 14:33:02
带 @符号的是 gin-swagger https://github.com/swaggo/gin-swagger
gin 框架的接口文档注释只能手写
knva 小成 2024-9-5 14:30:43
写一遍,然后剩下的 copilot 生成。
monkeyWie 小成 2024-9-5 14:30:24
就是手写的啊,go 的生态就是这样,毕竟官方不支持注解只能走歪门邪道了
ninjashixuan 小成 2024-9-5 14:28:25
如上面提到就是 swag 用来生成 swagger 文档的,当然不定全部手动,一些简单 curd 场景可以写脚本自动生成。
NX2023 小成 2024-9-5 14:25:27
@falcon05 #6 https://www.fshex.com/help/assertive
「请不要把 AI 生成的回复,当作你自己的回复,发到这里。」
12下一页
返回顶部