From 07d66ced1ea2fa71f2a8e88351308783043f3ed5 Mon Sep 17 00:00:00 2001
From: Mmx <1624045573@qq.com>
Date: Thu, 2 Dec 2021 13:46:01 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E5=A2=9E=E5=8A=A0=E6=B3=A8=E9=87=8A?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 controllers/daemon.go   | 4 ++++
 controllers/guardian.go | 2 ++
 controllers/login.go    | 1 +
 global/flags.go         | 7 +++++--
 util/checker.go         | 1 +
 util/util.go            | 5 +++++
 6 files changed, 18 insertions(+), 2 deletions(-)

diff --git a/controllers/daemon.go b/controllers/daemon.go
index 9cfa8bf..9fb6e60 100644
--- a/controllers/daemon.go
+++ b/controllers/daemon.go
@@ -14,6 +14,7 @@ type daemon struct {
 	Path string
 }
 
+// Daemon 后台模式控制包
 var Daemon = daemon{
 	Mark: fmt.Sprint(time.Now().UnixNano()),
 	Path: global.Config.Settings.Daemon.Path,
@@ -25,10 +26,12 @@ func init() {
 	}
 }
 
+// MarkDaemon 写入后台标记文件
 func (a *daemon) MarkDaemon() error {
 	return tool.File.Write(a.Path, []byte(a.Mark))
 }
 
+// CheckDaemon 检查后台标记文件
 func (a *daemon) CheckDaemon() bool {
 	if data, err := tool.File.Read(a.Path); err != nil {
 		return false
@@ -37,6 +40,7 @@ func (a *daemon) CheckDaemon() bool {
 	}
 }
 
+// DaemonChan 后台标记文件监听
 func (a *daemon) DaemonChan() bool {
 	f, err := fsnotify.NewWatcher()
 	if err != nil {
diff --git a/controllers/guardian.go b/controllers/guardian.go
index 2190dbc..40f2965 100644
--- a/controllers/guardian.go
+++ b/controllers/guardian.go
@@ -8,6 +8,7 @@ import (
 	"time"
 )
 
+// Guardian 守护模式逻辑
 func Guardian(output bool) {
 	util.Log.OutPut = output
 
@@ -44,6 +45,7 @@ func Guardian(output bool) {
 	}
 }
 
+// EnterGuardian 守护模式入口，控制是否进入daemon
 func EnterGuardian() {
 	util.Log.OutPut = true
 	util.Log.Println("[Guardian mode]")
diff --git a/controllers/login.go b/controllers/login.go
index fdc8239..a40dd0d 100644
--- a/controllers/login.go
+++ b/controllers/login.go
@@ -6,6 +6,7 @@ import (
 	"github.com/Mmx233/BitSrunLoginGo/v1/transfer"
 )
 
+// Login 登录逻辑
 func Login(output bool, skipCheck bool) error {
 	return BitSrun.Login(&srunTransfer.Login{
 		Demo:     global.Config.Settings.DemoMode,
diff --git a/global/flags.go b/global/flags.go
index 0d9f3d8..af2175f 100644
--- a/global/flags.go
+++ b/global/flags.go
@@ -5,9 +5,12 @@ import (
 )
 
 var Flags struct {
-	Path          string
+	//配置文件路径
+	Path string
+	//daemon模式内置标记
 	RunningDaemon bool
-	Daemon        bool
+	//强制daemon
+	Daemon bool
 }
 
 func initFlags() {
diff --git a/util/checker.go b/util/checker.go
index c0b7094..7fb1d67 100644
--- a/util/checker.go
+++ b/util/checker.go
@@ -9,6 +9,7 @@ type checker struct{}
 
 var Checker checker
 
+// NetOk 网络状况检查
 func (checker) NetOk(timeout uint) bool {
 	h, _, e := tool.HTTP.GetBytes(&tool.GetRequest{
 		Url:      "https://www.baidu.com/",
diff --git a/util/util.go b/util/util.go
index a61fdf9..4ef9288 100644
--- a/util/util.go
+++ b/util/util.go
@@ -21,6 +21,7 @@ func Search(reg string, content string) (string, error) {
 	}
 }
 
+// GetIp 从响应获取本机分配到的IP
 func GetIp(body string) (string, error) {
 	//判断原正则是否有匹配，如果无就使用新正则尝试
 	if ip, e := Search("id=\"user_ip\" value=\"(.*?)\"", body); e == nil {
@@ -29,20 +30,24 @@ func GetIp(body string) (string, error) {
 	return Search("ip     : \"(.*?)\"", body)
 }
 
+// GetToken 从响应获取token
 func GetToken(body string) (string, error) {
 	return Search("\"challenge\":\"(.*?)\"", body)
 }
 
+// GetResult 从响应获取登录结果
 func GetResult(body string) (string, error) {
 	return Search("\"error\":\"(.+?)\"", body)
 }
 
+// Md5 编码
 func Md5(content string) string {
 	w := md5.New()
 	_, _ = io.WriteString(w, content)
 	return fmt.Sprintf("%x", w.Sum(nil))
 }
 
+// Sha1 编码
 func Sha1(content string) string {
 	h := sha1.New()
 	h.Write([]byte(content))