docs: 优化文档展示，适配部分无目录文档，适配非结构体的类型定义，增加测试用例文档

server/lockstep/README.md

@@ -1,19 +1,20 @@
 # Lockstep
 
-
-
 [![Go doc](https://img.shields.io/badge/go.dev-reference-brightgreen?logo=go&logoColor=white&style=flat)](https://pkg.go.dev/github.com/kercylan98/minotaur/lockstep)
 ![](https://img.shields.io/badge/Email-kercylan@gmail.com-green.svg?style=flat)
 
-## 目录
-列出了该 `package` 下所有的函数，可通过目录进行快捷跳转 ❤️
+
+
+
+## 目录导航
+列出了该 `package` 下所有的函数及类型定义，可通过目录导航进行快捷跳转 ❤️
 <details>
-<summary>展开 / 折叠目录</summary
+<summary>展开 / 折叠目录导航</summary>
 
 
 > 包级函数定义
 
-|函数|描述
+|函数名称|描述
 |:--|:--
 |[NewLockstep](#NewLockstep)|创建一个锁步（帧）同步默认实现的组件(Lockstep)进行返回
 |[WithFrameLimit](#WithFrameLimit)|通过特定逻辑帧上限创建锁步（帧）同步组件
@@ -22,31 +23,72 @@
 |[WithInitFrame](#WithInitFrame)|通过特定的初始帧创建锁步（帧）同步组件
 
 
-> 结构体定义
+> 类型定义
 
-|结构体|描述
-|:--|:--
-|[Client](#client)|帧同步客户端接口定义
-|[StoppedEventHandle](#stoppedeventhandle)|暂无描述...
-|[Lockstep](#lockstep)|锁步（帧）同步默认实现
-|[Option](#option)|暂无描述...
+|类型|名称|描述
+|:--|:--|:--
+|`INTERFACE`|[Client](#client)|帧同步客户端接口定义
+|`STRUCT`|[StoppedEventHandle](#stoppedeventhandle)|暂无描述...
+|`STRUCT`|[Lockstep](#lockstep)|锁步（帧）同步默认实现
+|`STRUCT`|[Option](#option)|暂无描述...
 
 </details>
 
 
+***
+## 详情信息
 #### func NewLockstep(options ...Option[ClientID, Command])  *Lockstep[ClientID, Command]
 <span id="NewLockstep"></span>
 > 创建一个锁步（帧）同步默认实现的组件(Lockstep)进行返回
+
+<details>
+<summary>查看 / 收起单元测试</summary>
+
+
+```go
+
+func TestNewLockstep(t *testing.T) {
+	ls := lockstep.NewLockstep[string, int](lockstep.WithInitFrame[string, int](1))
+	ls.JoinClient(&Cli{id: "player_1"})
+	ls.JoinClient(&Cli{id: "player_2"})
+	count := 0
+	ls.StartBroadcast()
+	endChan := make(chan bool)
+	go func() {
+		for {
+			ls.AddCommand(random.Int(1, 9999))
+			count++
+			if count >= 10 {
+				break
+			}
+			time.Sleep(time.Millisecond * time.Duration(random.Int(10, 200)))
+		}
+		ls.StopBroadcast()
+		endChan <- true
+	}()
+	<-endChan
+	time.Sleep(time.Second)
+	fmt.Println("end")
+}
+
+```
+
+
+</details>
+
+
 ***
 #### func WithFrameLimit(frameLimit int64)  Option[ClientID, Command]
 <span id="WithFrameLimit"></span>
 > 通过特定逻辑帧上限创建锁步（帧）同步组件
 >   - 当达到上限时将停止广播
+
 ***
 #### func WithFrameRate(frameRate int64)  Option[ClientID, Command]
 <span id="WithFrameRate"></span>
 > 通过特定逻辑帧率创建锁步（帧）同步组件
 >   - 默认情况下为 15/s
+
 ***
 #### func WithSerialization(handle func (frame int64, commands []Command)  []byte)  Option[ClientID, Command]
 <span id="WithSerialization"></span>
@@ -58,24 +100,29 @@
 >     Frame int `json:"frame"`
 >     Commands []Command `json:"commands"`
 >     }
+
 ***
 #### func WithInitFrame(initFrame int64)  Option[ClientID, Command]
 <span id="WithInitFrame"></span>
 > 通过特定的初始帧创建锁步（帧）同步组件
 >   - 默认情况下为 0，即第一帧索引为 0
+
 ***
-### Client
+### Client `INTERFACE`
 帧同步客户端接口定义
   - 客户端应该具备ID及写入数据包的实现
 ```go
-type Client[ID comparable] struct{}
+type Client[ID comparable] interface {
+	GetID() ID
+	Write(packet []byte, callback ...func(err error))
+}
 ```
-### StoppedEventHandle
+### StoppedEventHandle `STRUCT`
 
 ```go
-type StoppedEventHandle[ClientID comparable, Command any] struct{}
+type StoppedEventHandle[ClientID comparable, Command any] func(lockstep *Lockstep[ClientID, Command])
 ```
-### Lockstep
+### Lockstep `STRUCT`
 锁步（帧）同步默认实现
   - 支持最大帧上限 WithFrameLimit
   - 自定逻辑帧频率，默认为每秒15帧(帧/66ms) WithFrameRate
@@ -102,8 +149,8 @@ type Lockstep[ClientID comparable, Command any] struct {
 	lockstepStoppedEventHandles []StoppedEventHandle[ClientID, Command]
 }
 ```
-### Option
+### Option `STRUCT`
 
 ```go
-type Option[ClientID comparable, Command any] struct{}
+type Option[ClientID comparable, Command any] func(lockstep *Lockstep[ClientID, Command])
 ```