docs: 优化 README.md 的测试用例描述
This commit is contained in:
@@ -300,7 +300,8 @@ func TestNewBot(t *testing.T) {
|
||||
<span id="New"></span>
|
||||
> 根据特定网络类型创建一个服务器
|
||||
|
||||
示例代码:
|
||||
**示例代码:**
|
||||
|
||||
```go
|
||||
|
||||
func ExampleNew() {
|
||||
@@ -351,7 +352,8 @@ func TestNew(t *testing.T) {
|
||||
<span id="BindService"></span>
|
||||
> 绑定服务到特定 Server,被绑定的服务将会在 Server 初始化时执行 Service.OnInit 方法
|
||||
|
||||
示例代码:
|
||||
**示例代码:**
|
||||
|
||||
```go
|
||||
|
||||
func ExampleBindService() {
|
||||
@@ -860,7 +862,8 @@ type Server struct {
|
||||
> - server.NetworkWebsocket (addr:":8888/ws")
|
||||
> - server.NetworkKcp (addr:":8888")
|
||||
> - server.NetworkNone (addr:"")
|
||||
示例代码:
|
||||
**示例代码:**
|
||||
|
||||
```go
|
||||
|
||||
func ExampleServer_Run() {
|
||||
|
||||
@@ -40,7 +40,8 @@
|
||||
<span id="NewDispatcher"></span>
|
||||
> 创建一个新的消息分发器 Dispatcher 实例
|
||||
|
||||
示例代码:
|
||||
**示例代码:**
|
||||
|
||||
```go
|
||||
|
||||
func ExampleNewDispatcher() {
|
||||
@@ -111,7 +112,8 @@ func TestNewDispatcher(t *testing.T) {
|
||||
<span id="NewManager"></span>
|
||||
> 生成消息分发器管理器
|
||||
|
||||
示例代码:
|
||||
**示例代码:**
|
||||
|
||||
```go
|
||||
|
||||
func ExampleNewManager() {
|
||||
|
||||
@@ -37,7 +37,8 @@
|
||||
<span id="NewMultistage"></span>
|
||||
> 创建一个支持多级分类的路由器
|
||||
|
||||
示例代码:
|
||||
**示例代码:**
|
||||
|
||||
```go
|
||||
|
||||
func ExampleNewMultistage() {
|
||||
@@ -76,7 +77,8 @@ type Multistage[HandleFunc any] struct {
|
||||
#### func (*Multistage) Register(routes ...any) MultistageBind[HandleFunc]
|
||||
> 注册路由是结合 Sub 和 Route 的快捷方式,用于一次性注册多级路由
|
||||
> - 该函数将返回一个注册函数,可通过调用其将路由绑定到特定处理函数,例如:router.Register("a", "b").Bind(onExec())
|
||||
示例代码:
|
||||
**示例代码:**
|
||||
|
||||
```go
|
||||
|
||||
func ExampleMultistage_Register() {
|
||||
@@ -90,7 +92,8 @@ func ExampleMultistage_Register() {
|
||||
***
|
||||
#### func (*Multistage) Route(route any, handleFunc HandleFunc)
|
||||
> 为特定路由绑定处理函数,被绑定的处理函数将可以通过 Match 函数进行匹配
|
||||
示例代码:
|
||||
**示例代码:**
|
||||
|
||||
```go
|
||||
|
||||
func ExampleMultistage_Route() {
|
||||
@@ -105,7 +108,8 @@ func ExampleMultistage_Route() {
|
||||
#### func (*Multistage) Match(routes ...any) HandleFunc
|
||||
> 匹配已绑定处理函数的路由,返回处理函数
|
||||
> - 如果未找到将会返回空指针
|
||||
示例代码:
|
||||
**示例代码:**
|
||||
|
||||
```go
|
||||
|
||||
func ExampleMultistage_Match() {
|
||||
@@ -154,7 +158,8 @@ func TestMultistage_Match(t *testing.T) {
|
||||
***
|
||||
#### func (*Multistage) Sub(route any) *Multistage[HandleFunc]
|
||||
> 获取子路由器
|
||||
示例代码:
|
||||
**示例代码:**
|
||||
|
||||
```go
|
||||
|
||||
func ExampleMultistage_Sub() {
|
||||
|
||||
@@ -53,7 +53,8 @@
|
||||
>
|
||||
> 传入 writeHandler 的消息对象是从 pool 中获取的,并且在 writeHandler 执行完成后会被放回 pool 中,因此 writeHandler 不应该持有消息对象的引用,同时也不应该主动释放消息对象
|
||||
|
||||
示例代码:
|
||||
**示例代码:**
|
||||
|
||||
```go
|
||||
|
||||
func ExampleNewUnbounded() {
|
||||
|
||||
Reference in New Issue
Block a user