docs: 为其余模块添加标准化 godoc 注释

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
xfy 2026-04-20 11:23:04 +08:00
parent 13bfc090f7
commit 3d80b12f7d
5 changed files with 7 additions and 5 deletions

View File

@ -530,7 +530,7 @@ func (a *App) gracefulUpgrade() {
// sigName 返回信号名称(用于日志输出)。
func sigName(sig syscall.Signal) string {
//nolint:exhaustive
//nolint:exhaustive // 只处理应用关心的信号
switch sig {
case syscall.SIGTERM:
return "SIGTERM"

View File

@ -5,7 +5,8 @@
// - IsValidAlgorithm 算法有效性校验函数
//
// 主要用途:
// 用于校验和枚举系统支持的负载均衡算法类型,供配置解析和路由选择使用。
//
// 用于校验和枚举系统支持的负载均衡算法类型,供配置解析和路由选择使用。
//
// 注意事项:
// - 新增算法时必须同步更新 ValidAlgorithms 列表

View File

@ -9,7 +9,8 @@
// - 所有算法的横向对比测试
//
// 主要用途:
// 用于评估负载均衡算法在不同规模下的性能特征,指导算法选型和参数调优。
//
// 用于评估负载均衡算法在不同规模下的性能特征,指导算法选型和参数调优。
//
// 注意事项:
// - 基准测试使用并行模式RunParallel结果受 CPU 核心数影响

View File

@ -329,7 +329,7 @@ func parseLevel(level string) zerolog.Level {
// NewAppLogger 创建应用日志管理器。
//
// 根据配置创建 AppLogger 实例,用于统一管理应用生命周期日志
//(启动、停止、信号处理等)。默认使用 text 格式输出到错误日志路径。
// (启动、停止、信号处理等)。默认使用 text 格式输出到错误日志路径。
//
// 参数:
// - cfg: 日志配置,包含输出路径、级别、格式等设置

View File

@ -428,7 +428,7 @@ func (vc *Context) EphemeralGet(name string) []byte {
// PersistentGet 获取持久化字符串变量值。
//
// 当需要跨请求存储变量值时使用此方法
//(如保存到数据库、缓存或长期存活的结构体中)。
// (如保存到数据库、缓存或长期存活的结构体中)。
func (vc *Context) PersistentGet(name string) string {
// 直接调用 Get它返回 string
v, _ := vc.Get(name)