Golang Go语言中求助代码注释貌似是某个插件生成的

大家好，我最近在学习使用 Go 语言进行后端开发，遇到了一个问题，希望能得到大家的帮助。我在项目中看到了一些类似 Swagger 风格的注释，像这样：

// [@Tags](/user/Tags) App
// [@Summary](/user/Summary) Page app installed
// [@Description](/user/Description) 分页获取已安装应用列表
// [@Accept](/user/Accept) json
// [@Param](/user/Param) request body request.AppInstalledSearch true "request"
// [@Success](/user/Success) 200
// [@Security](/user/Security) ApiKeyAuth
// [@Router](/user/Router) /apps/installed/search [post]

请问 这些注释是如何生成的？是否有 IDE 插件可以自动补全这些注释？否则我在 IDE 里面太容易写不对这样的注释了

Golang Go语言中求助代码注释貌似是某个插件生成的

yibo5220 1楼•4 个月前

可以利用 vscode 的 snippets 来做

更多关于Golang Go语言中求助代码注释貌似是某个插件生成的的实战系列教程也可以访问 https://www.itying.com/category-94-b0.html

gougou168 2楼•4 个月前

手写的

sinazl 3楼•4 个月前

复制粘贴改一改

phonegap100 4楼•4 个月前

这些注释是用来生成 API 文档的，通常使用的是 Swagger （现在叫 OpenAPI ）规范。在 Go 语言中，常用的工具是swaggo/swag。你可以通过安装这个工具来生成这些注释。

具体步骤如下：
1. 安装swag工具：在命令行中运行go get -u <a target="_blank" href="http://github.com/swaggo/swag/cmd/swag" rel="nofollow noopener">github.com/swaggo/swag/cmd/swag</a>。
2. 在你的 Go 项目中运行swag init，这会根据你的代码生成注释。

至于 IDE 插件，JetBrains 的 GoLand IDE 有一个官方插件叫做“Goanno”，可以帮助你自动补全这些注释。如果你使用的是 VS Code ，也有一些插件如“Go for Visual Studio Code”可以提供类似的功能。

wuwangju 5楼•4 个月前

#4 怎么一股 AI 的味道.

gougou168 6楼•4 个月前

看到 v 站上有很多提问，我就写了一个油猴脚本，尝试用 AI 回答问题，看着还挺像回事，就没忍住发了出去。求放过，别举报我，下次我自己看好了。。。。

sinazl 7楼•4 个月前

#6 把你的脚本交出来就不举报你

yibo5220 8楼•4 个月前

不会手写的把，因为太多了太多了，1panel 几乎每一个 func 都有

zlyuanteng 9楼•4 个月前

我们项目都是手写的。。。

sinazl 10楼•4 个月前

#6 https://www.v2ex.com/help/assertive
「请不要把 AI 生成的回复，当作你自己的回复，发到这里。」

sinazl 11楼•4 个月前

我知道，我想撤回了

phonegap100 12楼•4 个月前

如上面提到就是 swag 用来生成 swagger 文档的，当然不定全部手动，一些简单 curd 场景可以写脚本自动生成。

wuwangju 13楼•4 个月前

就是手写的啊，go 的生态就是这样，毕竟官方不支持注解只能走歪门邪道了

ionicwang 14楼•4 个月前

写一遍，然后剩下的 copilot 生成。

sinazl 15楼•4 个月前

带 @符号的是 gin-swagger https://github.com/swaggo/gin-swagger
gin 框架的接口文档注释只能手写

caililin 16楼•4 个月前

感谢感谢

caililin 17楼•4 个月前

只是把别人用 AI 总结的油猴脚本改成提问的，传到 greasyfork 了。

https://greasyfork.org/zh-CN/scripts/506898-v2ex-ai-%E5%9B%9E%E7%AD%94%E9%97%AE%E9%A2%98

wuwangju 18楼•4 个月前

#4 这位网友，你也不想你的回复被举报吧

eggper 19楼•4 个月前

我是找个类似的接口复制改一下

ionicwang 20楼•4 个月前

我倒是 IDEA 给自己团队写了一个接口文档生成插件。

自动遍历深层的代码注释作为接口字段说明的值，如果没注释，先找同代码文件的同字段注释（一般一组 API 都是一个业务的），如果还没有找插件内置字典，还没有就留空。

caililin 21楼•4 个月前

手写的

itying888 22楼•4 个月前

手写的，然后 swag 根据手写的注释生成接口文档或者导入到 apifox 里

eggper 23楼•4 个月前

#8 就是手写的一般, 我们 golang 程序员就是这么狠

zlyuanteng 24楼•4 个月前

在Go语言中，代码注释通常是由开发者手动添加的，用于解释代码的功能、逻辑或实现细节。然而，你提到的注释由某个插件生成的情况也是可能存在的，特别是在使用集成开发环境（IDE）或代码编辑器时。

一些IDE和编辑器插件能够自动生成注释，例如函数签名上的文档字符串（docstring）或者代码块上的描述性注释。这些插件可能通过分析代码的结构和命名约定来生成注释，帮助开发者更快地理解代码。

如果你发现代码中的注释是由插件生成的，并且这些注释不符合你的需求或风格，你可以考虑以下几个步骤：

识别插件：首先确定是哪个插件生成的注释。通常，IDE或编辑器的插件管理器会显示已安装的插件列表。
配置插件：检查插件的设置，看是否有选项可以调整注释的生成方式或禁用注释生成功能。
手动编辑：如果插件生成的注释不符合要求，你可以手动编辑这些注释，以确保它们准确反映代码的功能和逻辑。
考虑代码风格：与团队成员讨论并确定一个统一的代码注释风格，以确保代码库的一致性和可读性。

最后，虽然插件生成的注释可能提供了一定的便利性，但手动编写的注释通常更能准确反映开发者的意图和代码的逻辑。因此，在可能的情况下，建议开发者亲自编写注释。

回到顶部

你好，我是IT营的 AI 助手

您可以尝试点击下方的快捷入口开启体验！