完善注释

miclog.go

@@ -29,13 +29,10 @@ type logStruct struct {
 var _miclog micLog
 
 /*********************************************************************
-函数名:初始化
-参  数:path string:文件路径
-	name string :文件名,程序自动添加log后缀名,并且自动添加日期
-	maxSize int :文件最大尺寸(kb)
-	saveDay int :文件最大存储时间(Day)
-返回值:*MicLog
-创建时间:2018年12月20日
+功  能:初始化
+参  数:无
+返回值:无
+创建时间:2020年10月26日
 修订信息:
 *********************************************************************/
 func init() {
@@ -49,22 +46,67 @@ func init() {
 	go _miclog.run()
 }
 
+/*********************************************************************
+功  能:关闭
+参  数:无
+返回值:无
+创建时间:2020年10月26日
+修订信息:
+*********************************************************************/
 func (log *micLog) close() {
 	close(log.cache)
 }
 
+/*********************************************************************
+功  能:用户配置信息
+参  数:
+	   logpath string:日志文件存储路径
+	   logname string:日志文件名称
+	   maxsize int:日志文件最大字节数
+	   saveday int:保存时间(天)
+返回值:无
+创建时间:2020年10月26日
+修订信息:
+*********************************************************************/
 func Config(logpath, logname string, maxsize, saveday int) {
 	_miclog.path = logpath
 	_miclog.name = logname
 	_miclog.maxSize = maxsize
 	_miclog.saveDay = saveday
 }
 
+/*********************************************************************
+功  能:写入 Info 类型的日志
+参  数:
+	   log string:日志信息
+	   args interface{}:日志信息中的可选参数
+返回值:无
+创建时间:2020年10月26日
+修订信息:
+*********************************************************************/
 func Info(log string, args ...interface{}) {
 	lg := newlog(5, log, args...)
 	_miclog.cache <- lg
 }
 
+/*********************************************************************
+功  能:新的日志信息
+参  数:
+	   logtype int:日志类型.
+			0:EMER 系统级紧急，比如磁盘出错，内存异常，网络不可用等	红色底
+			1:ALRT 系统级警告，比如数据库访问异常，配置文件出错等	紫色
+			2:CRIT 系统级危险，比如权限出错，访问异常等	蓝色
+			3:EROR 用户级错误	红色
+			4:WARN 用户级警告	黄色
+			5:INFO 用户级重要	天蓝色
+			6:DEBG 用户级调试	绿色
+			7:TRAC 用户级基本输出	绿色用户级基本输出	绿色
+	   log string:日志信息
+	   args interface{}:日志信息中的可选参数
+返回值:无
+创建时间:2020年10月26日
+修订信息:
+*********************************************************************/
 func newlog(logtype int, log string, args ...interface{}) logStruct {
 	var lg logStruct
 	lg.Message = fmt.Sprintf(log, args...)
@@ -111,6 +153,14 @@ func (log *micLog) run() {
 	}
 }
 
+/*********************************************************************
+功  能:检查日志文件是否超限
+参  数:无
+返回值:无
+说  明:用作go线程,每小时执行一次
+创建时间:2020年10月26日
+修订信息:
+*********************************************************************/
 func (log *micLog) checklog() {
 	time.Sleep(1 * time.Minute)
 	for {
@@ -120,7 +170,7 @@ func (log *micLog) checklog() {
 }
 
 /*********************************************************************
-函数名：writeLog(filepath, content string)
+函数名:写日志信息进入文件
 参  数:content string:需要记录的信息
 	isprint bool:是否在控制台打印显示
 返回值:无
@@ -154,10 +204,8 @@ func (log *micLog) WriteLog() {
 }
 
 /***************************************************************
-函数名:checkLogFiles(path string, maxSize, saveDay int)
 功  能:检查日志文件是否存在尺寸过大或者存储时间超时的文件,有则删除之
-参  数:path string:日志文件存储目录路径
-      maxSize, saveDay int:文件最大容量(kb)和存储时间(day)
+参  数:
 返回值:无
 创建时间:2019年2月1日
 修订信息: