From 25cc9564a21d6a7492c010581df50a8492763257 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=99=BD=E8=8C=B6=E6=B8=85=E6=AC=A2?= Date: Fri, 26 Dec 2025 10:47:40 +0800 Subject: [PATCH] feat: update comment --- router/define.go | 10 +++++----- router/option.go | 40 ---------------------------------------- 2 files changed, 5 insertions(+), 45 deletions(-) diff --git a/router/define.go b/router/define.go index f629ce7..0d54038 100644 --- a/router/define.go +++ b/router/define.go @@ -15,20 +15,20 @@ const ( PrefixFuncName = "RouterPrefix" // 路由前缀函数名称 MiddlewareFuncName = "RouterMiddleware" // 路由中间件函数名称 GinContextType = "*gin.Context" // gin context 类型名称 - ErrorType = "error" // error类型 - ErrorInterfaceFuncName = "Error" // error接口需要实现的方法名称 + ErrorType = "error" // error 类型 + ErrorInterfaceFuncName = "Error" // error 接口需要实现的方法名称 ) const ( TagNamePath = "path" // 接口的请求路径 TagNameMethod = "method" // 接口的请求方法 - TagNameUriTag = "tag" // 接口的tag + TagNameUriTag = "tag" // 接口的 tag TagNameDesc = "desc" // 接口的描述 TagNameOutputStrict = "output_strict" // 接口数据是否为严格模式 : 严格模式, 响应数据必须是结构体/map，非严格模式返回任意值 - TagNameHookSync = "hook-sync" // hook同步执行 + TagNameHookSync = "hook-sync" // hook 同步执行 TagNameBinding = "binding" // gin 内置的验证规则tag TagNameValidate = "validate" // validator v10 默认的验证规则tag - TagNameErrMsg = "err" // 验证失败错误信息tag + TagNameErrMsg = "err" // 验证失败错误信息 tag ) // UriConfig 接口配置 diff --git a/router/option.go b/router/option.go index e79bc3f..b551c21 100644 --- a/router/option.go +++ b/router/option.go @@ -18,10 +18,6 @@ import ( type SetServerOptionFunc func(so *serverOption) // serverOption 获取server实例的选项 -// -// Author : go_developer@163.com<白茶清欢> -// -// Date : 17:28 2025/2/18 type serverOption struct { swaggerUiTheme string // swagger 主题 swaggerBaseUri string // swagger基础path @@ -60,10 +56,6 @@ func WithInitContextData(formatFunc func(ctx *gin.Context) map[string]any) SetSe } // WithSwaggerUITheme 设置swaggerUI主题 -// -// Author : go_developer@163.com<白茶清欢> -// -// Date : 17:29 2025/2/18 func WithSwaggerUITheme(uiTheme string) SetServerOptionFunc { return func(so *serverOption) { uiTheme = strings.TrimSpace(uiTheme) @@ -75,10 +67,6 @@ func WithSwaggerUITheme(uiTheme string) SetServerOptionFunc { } // WithGlobalMiddlewareList 设置全局中间件 -// -// Author : go_developer@163.com<白茶清欢> -// -// Date : 17:33 2025/2/18 func WithGlobalMiddlewareList(middlewareList ...gin.HandlerFunc) SetServerOptionFunc { return func(so *serverOption) { so.globalMiddlewareList = middlewareList @@ -86,10 +74,6 @@ func WithGlobalMiddlewareList(middlewareList ...gin.HandlerFunc) SetServerOption } // WithSwaggerBaseUri ... -// -// Author : go_developer@163.com<白茶清欢> -// -// Date : 18:05 2025/2/18 func WithSwaggerBaseUri(baseUri string) SetServerOptionFunc { return func(so *serverOption) { baseUri = strings.TrimSpace(baseUri) @@ -102,10 +86,6 @@ func WithSwaggerBaseUri(baseUri string) SetServerOptionFunc { } // WithDisableSwaggerDoc 禁用swagger文档 -// -// Author : go_developer@163.com<白茶清欢> -// -// Date : 17:35 2025/2/18 func WithDisableSwaggerDoc() SetServerOptionFunc { return func(so *serverOption) { so.disableSwaggerDoc = true @@ -113,10 +93,6 @@ func WithDisableSwaggerDoc() SetServerOptionFunc { } // WithServerInfo 设置serverInfo -// -// Author : go_developer@163.com<白茶清欢> -// -// Date : 17:51 2025/2/18 func WithServerInfo(serverInfo *apiDocDefine.Info) SetServerOptionFunc { return func(so *serverOption) { if nil == serverInfo { @@ -127,10 +103,6 @@ func WithServerInfo(serverInfo *apiDocDefine.Info) SetServerOptionFunc { } // WithServerList 设置服务器列表 -// -// Author : go_developer@163.com<白茶清欢> -// -// Date : 17:52 2025/2/18 func WithServerList(serverList []*apiDocDefine.ServerItem) SetServerOptionFunc { return func(so *serverOption) { if len(serverList) == 0 { @@ -141,10 +113,6 @@ func WithServerList(serverList []*apiDocDefine.ServerItem) SetServerOptionFunc { } // WithPprofEnable 启用pprof -// -// Author : go_developer@163.com<白茶清欢> -// -// Date : 15:10 2025/2/21 func WithPprofEnable() SetServerOptionFunc { return func(so *serverOption) { so.enablePprof = true @@ -152,10 +120,6 @@ func WithPprofEnable() SetServerOptionFunc { } // WithEnableCors 启用全局跨域 -// -// Author : go_developer@163.com<白茶清欢> -// -// Date : 14:56 2025/2/22 func WithEnableCors() SetServerOptionFunc { return func(so *serverOption) { so.enableCors = true @@ -163,10 +127,6 @@ func WithEnableCors() SetServerOptionFunc { } // WithLoggerCfg ... -// -// Author : go_developer@163.com<白茶清欢> -// -// Date : 15:25 2025/2/22 func WithLoggerCfg(loggerCfg *middleware.AccessConfig) SetServerOptionFunc { return func(so *serverOption) { if nil != loggerCfg || nil != loggerCfg.Logger {