doc: format all markdown doc

2026-02-09 23:22:28 +08:00 · 2023-02-23 10:36:54 +08:00
parent 15c1537bf0
commit 24eb2bbacd
26 changed files with 3396 additions and 3567 deletions
--- a/docs/function_zh-CN.md
+++ b/docs/function_zh-CN.md
@@ -1,5 +1,6 @@
 # Function
-function函数包控制函数执行流程，包含部分函数式编程。
+
+function 函数包控制函数执行流程，包含部分函数式编程。

 <div STYLE="page-break-after: always;"></div>

@@ -11,6 +12,7 @@ function函数包控制函数执行流程，包含部分函数式编程。
 <div STYLE="page-break-after: always;"></div>

 ## 用法:
+
 ```go
 import (
    "github.com/duke-git/lancet/function"
@@ -20,21 +22,21 @@ import (
 <div STYLE="page-break-after: always;"></div>

 ## 目录
- [After](#After)
- [Before](#Before)
- [Curry](#Curry)
- [Compose](#Compose)
- [Debounced](#Debounced)
- [Delay](#Delay)
- [Watcher](#Watcher)
+
+-   [After](#After)
+-   [Before](#Before)
+-   [Curry](#Curry)
+-   [Compose](#Compose)
+-   [Debounced](#Debounced)
+-   [Delay](#Delay)
+-   [Watcher](#Watcher)

 <div STYLE="page-break-after: always;"></div>

 ## 文档

-
-
 ### <span id="After">After</span>
+
 <p>创建一个函数，当他被调用n或更多次之后将马上触发fn</p>

 <b>函数签名:</b>
@@ -42,6 +44,7 @@ import (
 ```go
 func After(n int, fn interface{}) func(args ...interface{}) []reflect.Value
 ```
+
 <b>例子:</b>

 ```go
@@ -53,33 +56,31 @@ import (
 )

 func main() {
-	arr := []string{"a", "b"}
-	f := function.After(len(arr), func(i int) int {
-		fmt.Println("last print")
-		return i
-	})
+    arr := []string{"a", "b"}
+    f := function.After(len(arr), func(i int) int {
+        fmt.Println("last print")
+        return i
+    })

-	type cb func(args ...interface{}) []reflect.Value
-	print := func(i int, s string, fn cb) {
-		fmt.Printf("arr[%d] is %s \n", i, s)
-		fn(i)
-	}
+    type cb func(args ...interface{}) []reflect.Value
+    print := func(i int, s string, fn cb) {
+        fmt.Printf("arr[%d] is %s \n", i, s)
+        fn(i)
+    }

-	fmt.Println("arr is", arr)
-	for i := 0; i < len(arr); i++ {
-		print(i, arr[i], f)
-	}
+    fmt.Println("arr is", arr)
+    for i := 0; i < len(arr); i++ {
+        print(i, arr[i], f)
+    }

    //output:
    // arr is [a b]
-    // arr[0] is a 
-    // arr[1] is b 
+    // arr[0] is a
+    // arr[1] is b
    // last print
 }
 ```

-
-
 ### <span id="Before">Before</span>

 <p>创建一个函数，调用次数不超过n次，之后再调用这个函数，将返回一次最后调用fn的结果</p>
@@ -89,6 +90,7 @@ func main() {
 ```go
 func Before(n int, fn interface{}) func(args ...interface{}) []reflect.Value
 ```
+
 <b>例子:</b>

 ```go
@@ -101,31 +103,29 @@ import (
 )

 func main() {
-	assert := internal.NewAssert(t, "TestBefore")
+    assert := internal.NewAssert(t, "TestBefore")

-	arr := []string{"a", "b", "c", "d", "e"}
-	f := function.Before(3, func(i int) int {
-		return i
-	})
+    arr := []string{"a", "b", "c", "d", "e"}
+    f := function.Before(3, func(i int) int {
+        return i
+    })

-	var res []int64
-	type cb func(args ...interface{}) []reflect.Value
-	appendStr := func(i int, s string, fn cb) {
-		v := fn(i)
-		res = append(res, v[0].Int())
-	}
+    var res []int64
+    type cb func(args ...interface{}) []reflect.Value
+    appendStr := func(i int, s string, fn cb) {
+        v := fn(i)
+        res = append(res, v[0].Int())
+    }

-	for i := 0; i < len(arr); i++ {
-		appendStr(i, arr[i], f)
-	}
+    for i := 0; i < len(arr); i++ {
+        appendStr(i, arr[i], f)
+    }

-	expected := []int64{0, 1, 2, 2, 2}
-	assert.Equal(expected, res)
+    expected := []int64{0, 1, 2, 2, 2}
+    assert.Equal(expected, res)
 }
 ```

-
-
 ### <span id="Curry">Curry</span>

 <p>创建一个柯里化的函数</p>
@@ -136,6 +136,7 @@ func main() {
 type Fn func(...interface{}) interface{}
 func (f Fn) Curry(i interface{}) func(...interface{}) interface{}
 ```
+
 <b>例子:</b>

 ```go
@@ -147,20 +148,18 @@ import (
 )

 func main() {
-	add := func(a, b int) int {
-		return a + b
-	}
-	var addCurry function.Fn = func(values ...interface{}) interface{} {
-		return add(values[0].(int), values[1].(int))
-	}
-	add1 := addCurry.Curry(1)
-	result := add1(2)
-	fmt.Println(result) //3
+    add := func(a, b int) int {
+        return a + b
+    }
+    var addCurry function.Fn = func(values ...interface{}) interface{} {
+        return add(values[0].(int), values[1].(int))
+    }
+    add1 := addCurry.Curry(1)
+    result := add1(2)
+    fmt.Println(result) //3
 }
 ```

-
-
 ### <span id="Compose">Compose</span>

 <p>从右至左组合函数列表fnList， 返回组合后的函数</p>
@@ -170,6 +169,7 @@ func main() {
 ```go
 func Compose(fnList ...func(...interface{}) interface{}) func(...interface{}) interface{}
 ```
+
 <b>例子:</b>

 ```go
@@ -181,22 +181,20 @@ import (
 )

 func main() {
-	add1 := func(v ...interface{}) interface{} {
-		return v[0].(int) + 1
-	}
-	add2 := func(v ...interface{}) interface{} {
-		return v[0].(int) + 2
-	}
+    add1 := func(v ...interface{}) interface{} {
+        return v[0].(int) + 1
+    }
+    add2 := func(v ...interface{}) interface{} {
+        return v[0].(int) + 2
+    }

-	add3 := function.Compose(add1, add2)
-	result := add3(1)
+    add3 := function.Compose(add1, add2)
+    result := add3(1)

-	fmt.Println(result) //4
+    fmt.Println(result) //4
 }
 ```

-
-
 ### <span id="Debounced">Debounced</span>

 <p>创建一个 debounced 函数，该函数延迟调用 fn 直到自上次调用 debounced 函数后等待持续时间过去。</p>
@@ -206,6 +204,7 @@ func main() {
 ```go
 func Debounced(fn func(), duration time.Duration) func()
 ```
+
 <b>例子:</b>

 ```go
@@ -217,28 +216,26 @@ import (
 )

 func main() {
-	count := 0
-	add := func() {
-		count++
-	}
+    count := 0
+    add := func() {
+        count++
+    }

-	debouncedAdd := function.Debounced(add, 50*time.Microsecond)
-	function.debouncedAdd()
-	function.debouncedAdd()
-	function.debouncedAdd()
-	function.debouncedAdd()
+    debouncedAdd := function.Debounced(add, 50*time.Microsecond)
+    function.debouncedAdd()
+    function.debouncedAdd()
+    function.debouncedAdd()
+    function.debouncedAdd()

-	time.Sleep(100 * time.Millisecond)
-	fmt.Println(count) //1
+    time.Sleep(100 * time.Millisecond)
+    fmt.Println(count) //1

-	function.debouncedAdd()
-	time.Sleep(100 * time.Millisecond)
-	fmt.Println(count) //2
+    function.debouncedAdd()
+    time.Sleep(100 * time.Millisecond)
+    fmt.Println(count) //2
 }
 ```

-
-
 ### <span id="Delay">Delay</span>

 <p>延迟delay时间后调用函数</p>
@@ -248,6 +245,7 @@ func main() {
 ```go
 func Delay(delay time.Duration, fn interface{}, args ...interface{})
 ```
+
 <b>例子:</b>

 ```go
@@ -259,15 +257,13 @@ import (
 )

 func main() {
-	var print = func(s string) {
-		fmt.Println(count) //test delay
-	}
-	function.Delay(2*time.Second, print, "test delay")
+    var print = func(s string) {
+        fmt.Println(count) //test delay
+    }
+    function.Delay(2*time.Second, print, "test delay")
 }
 ```

-
-
 ### <span id="Schedule">Schedule</span>

 <p>每次持续时间调用函数，直到关闭返回的 bool chan</p>
@@ -277,6 +273,7 @@ func main() {
 ```go
 func Schedule(d time.Duration, fn interface{}, args ...interface{}) chan bool
 ```
+
 <b>例子:</b>

 ```go
@@ -289,20 +286,18 @@ import (

 func main() {
    var res []string
-	appendStr := func(s string) {
-		res = append(res, s)
-	}
+    appendStr := func(s string) {
+        res = append(res, s)
+    }

-	stop := function.Schedule(1*time.Second, appendStr, "*")
-	time.Sleep(5 * time.Second)
-	close(stop)
+    stop := function.Schedule(1*time.Second, appendStr, "*")
+    time.Sleep(5 * time.Second)
+    close(stop)

    fmt.Println(res) //[* * * * *]
 }
 ```

-
-
 ### <span id="Watcher">Watcher</span>

 <p>Watcher 用于记录代码执行时间。可以启动/停止/重置手表定时器。获取函数执行的时间。 </p>
@@ -311,15 +306,16 @@ func main() {

 ```go
 type Watcher struct {
-	startTime int64
-	stopTime  int64
-	excuting  bool
+    startTime int64
+    stopTime  int64
+    excuting  bool
 }
 func (w *Watcher) Start() //start the watcher
 func (w *Watcher) Stop() //stop the watcher
 func (w *Watcher) Reset() //reset the watcher
 func (w *Watcher) GetElapsedTime() time.Duration //get the elapsed time of function execution
 ```
+
 <b>例子:</b>

 ```go
@@ -332,33 +328,30 @@ import (

 func main() {
    w := &function.Watcher{}
-	w.Start()
+    w.Start()

-	longRunningTask()
+    longRunningTask()

-	fmt.Println(w.excuting) //true
+    fmt.Println(w.excuting) //true

-	w.Stop()
+    w.Stop()

-	eapsedTime := w.GetElapsedTime().Milliseconds()
-	fmt.Println(eapsedTime)
+    eapsedTime := w.GetElapsedTime().Milliseconds()
+    fmt.Println(eapsedTime)

-	w.Reset()
+    w.Reset()

-	fmt.Println(w.excuting) //false
+    fmt.Println(w.excuting) //false

-	fmt.Println(w.startTime) //0
-	fmt.Println(w.stopTime) //0
+    fmt.Println(w.startTime) //0
+    fmt.Println(w.stopTime) //0
 }

 func longRunningTask() {
-	var slice []int64
-	for i := 0; i < 10000000; i++ {
-		slice = append(slice, int64(i))
-	}
+    var slice []int64
+    for i := 0; i < 10000000; i++ {
+        slice = append(slice, int64(i))
+    }
 }

 ```
-
-
-