首页 > 其他分享 >vscode go语言注释语句黄色波浪线

vscode go语言注释语句黄色波浪线

时间:2024-11-18 15:40:15浏览次数:1  
标签:语句 vscode staticcheck 代码 波浪 注释 Go go

go语言注释代码总是飘着黄色波浪线提示:(with optional leading article) (ST1021)go-staticcheck,非常影响观感。

经过查询发现,go-staticcheck 是一个用于 Go 代码静态分析的工具,用来检测代码中的潜在问题、代码规范以及常见的错误。本次错误信息来自 go-staticcheck 中的规则 ST1021,指的是注释格式的问题

该规则要求注释以“类型名 …” 的形式开头,通常需要说明类型的作用或用途。go-staticcheck 之所以强调这个格式,是因为这符合 Go 的 规范和 Effective Go 的建议,有助于生成一致且清晰的文档。

解决方法1

按照规范,将注释修改为以类型名开头的完整句子格式

// SetRule 是一个定义某种规则的结构体。
type SetRule struct {
    // ...
}

解决方法2

屏蔽错误提示,配置 IDE 设置

Ctrl + Shift + p
image

image

回到代码中发现黄色波浪线消失了。

清爽!

标签:语句,vscode,staticcheck,代码,波浪,注释,Go,go
From: https://www.cnblogs.com/itsfei/p/18552828

相关文章

  • Django中QuerySet
    1.QuerySet概念QuerySet是DjangoORM(Object-RelationalMapping)中的对象,用于表示从数据库查询出来的一组数据。可以看作是数据库查询结果的抽象表示,包含零个或多个模型实例。特性延迟加载:QuerySet是惰性的,只有在需要时才会执行真正的数据库查询。例如,调用list......
  • 使用 Go 语言进行多时区时间转换
    使用Go语言进行多时区时间转换在日常开发中,我们经常会遇到跨境电商、国际会议调度等全球化应用的需求,这时处理多时区的时间就是一个普遍问题。例如,你可能需要将某个事件的北京时间转换为洛杉矶时间、纽约时间和伦敦时间等。本文将详细介绍如何使用Go语言优雅地完成这一任务。......
  • MySQL数据库的几种基本操作语句
    1.创建数据库`createdatabase[ifnotexists]database_name;`2.查看所有数据库`showdatabases;`3.删除数据库`dropdatabase[ifnotexists]database_name;`4.使用数据库`usedatabase_name;`注:对数据库中的表进行操作需要先使用该数据库5.查询当前数据库下的......
  • Go语言跨平台桌面应用开发新纪元:LCL、CEF与Webview全解析
    开篇寄语在Go语言的广阔生态中,桌面应用开发一直是一个备受关注的领域。今天,我将为大家介绍三款基于Go语言的跨平台桌面应用开发框架——LCL、CEF与Webview,它们分别拥有独特的魅力和广泛的应用场景。通过这三款框架,你将能够轻松开发出功能强大、界面美观的跨平台桌面应用程序。......
  • SqlSugar使用AOP获取sql语句
    publicISqlSugarClientDb{get{//sql执行前//_currentDb.Aop.OnLogExecuting=(sql,pars)=>//{////stringn1=UtilMethods.GetNativeSql(sql,pars);//日志使用......
  • 2024年腾讯云双十一活动:腾讯云11.11上云拼团Go活动详细说明
    一、2024年腾讯云双十一活动时间腾讯云双十一活动将于即日起至2024年11月30日,活动时间跨度很长,让用户有足够的时间选购自己所需的云产品和服务。具体以页面变更为准。二、2024年腾讯云双十一活动入口腾讯云双11活动入口:【点此直达】了解。​三、2024年腾讯云双十一活动......
  • golang调用第三方程序并实现交互输入自动化
    应用场景:在openwrt下调用移远的测试程序,并实现输入自动话,获取imeiroot@OpenWrt:~#ql-api-testTestgroups:0:ql_dsi1:ql_nw2:ql_sim3:ql_dev4:ql_voice5:ql_sms6:ql_adc7:ql_i2c8:ql_enit9:......
  • 异常值检测:SOS算法(Stochastic Outlier Selection Algorithm)MATLAB代码
    SOS算法(StochasticOutlierSelectionAlgorithm)是由JeroenJanssens提出的一种无监督异常检测算法。该算法通过计算数据点之间的关联度(affinity)来识别异常点。核心思想是,如果一个点与其他所有点的关联度都很低,那么它被视为异常点。以下是该算法的详细公式和步骤:其MATLAB代码......
  • 《Django 5 By Example》阅读笔记:p211-p236
    《Django5ByExample》学习第7天,p211-p236总结,总计26页。一、技术总结1.messages(消息推送)django.contrib.messages。2.OAuth2Django里使用的是social-app-django这个package进行认证操作。3.开发环境使用HTTPS使用django-extensions,werkzeug,pyOpenSSL实现。4.第三方......
  • aiortc && WebSocket and django-channels
    aiortchttps://github.com/aiortc/aiortc/tree/mainWebRTCandORTCimplementationforPythonusingasyncioWhatisaiortc?aiortcisalibraryforWebReal-TimeCommunication(WebRTC)andObjectReal-TimeCommunication(ORTC)inPython.Itisbuilton......