添加函数注释

yyle88 · Feb 21, 2025 · 0282faa · 0282faa
1 parent 41330b0
commit 0282faa
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 7 deletions.
diff --git a/check_func.go b/check_func.go
@@ -5,29 +5,32 @@ import (
 	"go.uber.org/zap"
 )
 
-// Done 当err非空是就panic且打印调用栈信息
+// Done panics and logs the stack trace if the error occurs, otherwise do nothing
+// Done 当err非空时就panic且打印调用栈信息
 func Done(err error) {
 	if err != nil {
 		zaplog.LOGS.Skip1.Panic("ERROR", zap.Error(err))
 	}
 }
 
-// Must 当err非空是就panic且打印调用栈信息
+// Must panics and logs the stack trace if the error occurs, otherwise do nothing
+// Must 当err非空时就panic且打印调用栈信息
 func Must(err error) {
 	if err != nil {
 		zaplog.LOGS.Skip1.Panic("ERROR", zap.Error(err))
 	}
 }
 
-// Soft 当err非空是就打印warning日志且打印调用栈信息
+// Soft logs a warning and the stack trace if the error occurs, otherwise do nothing
+// Soft 当err非空时就打印warning日志且打印调用栈信息
 func Soft(err error) {
 	if err != nil {
 		zaplog.LOGS.Skip1.Warn("WARN", zap.Error(err))
 	}
 }
 
+// Fata logs a fatal error and exits the system if the error occurs, otherwise do nothing
 // Fata 当出错时就是调用 log.Fatal 退出系统，当不出错时就不做任何事情
-// FaFaFaFaFa 哈哈哈哈哈
 func Fata(err error) {
 	if err != nil {
 		zaplog.LOGS.Skip1.Fatal("ERROR", zap.Error(err))

diff --git a/go.mod b/go.mod
@@ -5,7 +5,7 @@ go 1.22.6
 require (
 	github.com/pkg/errors v0.9.1
 	github.com/stretchr/testify v1.10.0
-	github.com/yyle88/zaplog v0.0.19
+	github.com/yyle88/zaplog v0.0.20
 	go.uber.org/zap v1.27.0
 )
 

diff --git a/go.sum b/go.sum
@@ -14,8 +14,8 @@ github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOf
 github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 github.com/yyle88/mutexmap v1.0.10 h1:PIsx9KTdK6h1yH5NzBrPl21RrZ/XsE4IbgulMlhJzZE=
 github.com/yyle88/mutexmap v1.0.10/go.mod h1:QUYDuARLPlGj414kHewQ5tt8jkDxQXoai8H3C4Gg+yc=
-github.com/yyle88/zaplog v0.0.19 h1:O4g7EO+uks7DkXbBXAje0LRvrBbkPuMD4gphuXw9jAo=
-github.com/yyle88/zaplog v0.0.19/go.mod h1:jN9/2IXYlpHOgoIyOTid1EPlUyGBWzFjr0dX9YKLkC0=
+github.com/yyle88/zaplog v0.0.20 h1:ByVj51j2C9p5tWw8wbIdmdrMK5IS6VECh/U746t321E=
+github.com/yyle88/zaplog v0.0.20/go.mod h1:jN9/2IXYlpHOgoIyOTid1EPlUyGBWzFjr0dX9YKLkC0=
 go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
 go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE=
 go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0=