Merge remote-tracking branch 'origin/后台运营yy' into 后台运营yy

tamguo-common/src/main/java/com/tamguo/common/utils/LogDebug.java

@@ -1,16 +1,33 @@
 package com.tamguo.common.utils;
 
+// LogDebug类主要用于在调试场景下输出相关的调试信息，提供了简单的方法来将调试消息打印到标准错误输出（System.err），方便开发人员在排查问题、跟踪代码执行流程时查看相关信息。
 public class LogDebug {
 
+	// 定义一个静态的字符串常量，作为调试日志的前缀，用于在输出调试信息时添加在具体消息内容前面，方便区分调试日志与其他类型的输出内容，使调试日志更具辨识度，便于查看和定位。
 	private final static String DEBUG_LOG_KEY = "-- LogHandler: ";
 
+	/**
+	 * 输出调试信息到标准错误输出（System.err）。
+	 * 该方法接收一个字符串类型的调试消息作为参数，然后将预先定义的调试日志前缀（DEBUG_LOG_KEY）与传入的调试消息拼接在一起，
+	 * 再通过System.err.println方法将拼接后的内容输出到标准错误输出流，这样在查看控制台输出时，能很容易识别出这是调试相关的信息。
+	 *
+	 * @param msg 要输出的调试消息内容，通常是一些对程序执行过程中关键步骤、变量值等用于辅助调试的描述信息，例如 "进入某方法，参数值为..."。
+	 */
 	public static void debug(String msg) {
 		System.err.println(DEBUG_LOG_KEY + msg);
 	}
 
+	/**
+	 * 输出调试信息到标准错误输出（System.err），同时如果传入了异常对象，也会将异常的堆栈信息输出到标准错误输出流。
+	 * 首先和`debug(String msg)`方法一样，将调试日志前缀（DEBUG_LOG_KEY）与传入的调试消息拼接后输出到标准错误输出流，以显示调试信息。
+	 * 接着判断传入的异常对象（Throwable类型的参数`t`）是否为`null`，如果不为`null`，则调用异常对象的`printStackTrace`方法，并指定输出流为System.err，将异常的详细堆栈信息也输出到标准错误输出流，方便开发人员查看出现异常的具体位置、调用栈等详细情况，有助于排查问题。
+	 *
+	 * @param msg 要输出的调试消息内容，例如对出现异常的上下文描述、相关业务逻辑的提示等，便于在查看调试日志时了解相关背景信息。
+	 * @param t 表示出现的异常情况的Throwable对象，包含了详细的异常类型、异常消息以及堆栈信息等内容，若为`null`则不会输出异常堆栈信息。
+	 */
 	public static void debug(String msg, Throwable t) {
 		System.err.println(DEBUG_LOG_KEY + msg);
-		if (t != null)
+		if (t!= null)
 			t.printStackTrace(System.err);
 	}