From 65aaba4e5953eeaaf8d3356f4179d4df3fdbc6d7 Mon Sep 17 00:00:00 2001 From: xfy911 Date: Wed, 3 Jun 2026 15:28:53 +0800 Subject: [PATCH] docs(config): add package comments for config module - Add package documentation for cache, monitoring, performance, proxy, security, server, ssl, and variable config files - Include author attribution (xfy) --- internal/config/cache_config.go | 5 +++++ internal/config/monitoring_config.go | 5 +++++ internal/config/performance_config.go | 5 +++++ internal/config/proxy_config.go | 5 +++++ internal/config/security_config.go | 5 +++++ internal/config/server_config.go | 5 +++++ internal/config/ssl_config.go | 5 +++++ internal/config/variable_config.go | 5 +++++ 8 files changed, 40 insertions(+) diff --git a/internal/config/cache_config.go b/internal/config/cache_config.go index 3b7e1e7..97bba9c 100644 --- a/internal/config/cache_config.go +++ b/internal/config/cache_config.go @@ -1,3 +1,8 @@ +// Package config 提供 YAML 配置文件的解析、验证和默认配置生成功能。 +// +// 包含缓存配置相关的结构体,用于控制代理缓存行为。 +// +// 作者:xfy package config import "time" diff --git a/internal/config/monitoring_config.go b/internal/config/monitoring_config.go index 1aa16fc..f6869b1 100644 --- a/internal/config/monitoring_config.go +++ b/internal/config/monitoring_config.go @@ -1,3 +1,8 @@ +// Package config 提供 YAML 配置文件的解析、验证和默认配置生成功能。 +// +// 包含监控配置相关的结构体,用于配置服务状态监控和健康检查端点。 +// +// 作者:xfy package config // MonitoringConfig 监控配置。 diff --git a/internal/config/performance_config.go b/internal/config/performance_config.go index b2926b0..6417f6c 100644 --- a/internal/config/performance_config.go +++ b/internal/config/performance_config.go @@ -1,3 +1,8 @@ +// Package config 提供 YAML 配置文件的解析、验证和默认配置生成功能。 +// +// 包含性能配置相关的结构体,用于控制服务器性能优化参数。 +// +// 作者:xfy package config import ( diff --git a/internal/config/proxy_config.go b/internal/config/proxy_config.go index 6bfa6be..06af244 100644 --- a/internal/config/proxy_config.go +++ b/internal/config/proxy_config.go @@ -1,3 +1,8 @@ +// Package config 提供 YAML 配置文件的解析、验证和默认配置生成功能。 +// +// 包含代理配置相关的结构体,用于配置反向代理行为。 +// +// 作者:xfy package config import ( diff --git a/internal/config/security_config.go b/internal/config/security_config.go index b0bbfdc..0c34838 100644 --- a/internal/config/security_config.go +++ b/internal/config/security_config.go @@ -1,3 +1,8 @@ +// Package config 提供 YAML 配置文件的解析、验证和默认配置生成功能。 +// +// 包含安全配置相关的结构体,用于配置访问控制、限流、认证和安全头部。 +// +// 作者:xfy package config import "time" diff --git a/internal/config/server_config.go b/internal/config/server_config.go index 88e41b1..87d4fa8 100644 --- a/internal/config/server_config.go +++ b/internal/config/server_config.go @@ -1,3 +1,8 @@ +// Package config 提供 YAML 配置文件的解析、验证和默认配置生成功能。 +// +// 包含服务器配置相关的结构体,用于配置监听地址、静态文件、代理、SSL 等设置。 +// +// 作者:xfy package config import "time" diff --git a/internal/config/ssl_config.go b/internal/config/ssl_config.go index 8f0c962..9f27c63 100644 --- a/internal/config/ssl_config.go +++ b/internal/config/ssl_config.go @@ -1,3 +1,8 @@ +// Package config 提供 YAML 配置文件的解析、验证和默认配置生成功能。 +// +// 包含 SSL/TLS 配置相关的结构体,用于配置 HTTPS 加密参数。 +// +// 作者:xfy package config import "time" diff --git a/internal/config/variable_config.go b/internal/config/variable_config.go index a59935f..d7b19da 100644 --- a/internal/config/variable_config.go +++ b/internal/config/variable_config.go @@ -1,3 +1,8 @@ +// Package config 提供 YAML 配置文件的解析、验证和默认配置生成功能。 +// +// 包含变量配置相关的结构体,用于配置自定义变量和内置变量。 +// +// 作者:xfy package config import "time"