文档优化

examples/multi-core-server-room-sync/main.go

@@ -1,3 +1,4 @@
+// 该案例中将服务器消息通过多核的方式异步传输到房间中，在每个房间中单独同步处理维护消息。
 package main
 
 import (

examples/simple-server-chatroom/main.go

@@ -1,3 +1,4 @@
+// 该案例实现了一个简单的聊天室功能
 package main
 
 import (

examples/simple-server-config/main.go

@@ -1,3 +1,4 @@
+// 该案例演示了配置导表工具的使用，其中包括了作为模板的配置文件及导出的配置文件
 package main
 
 import (

examples/simple-server-console/main.go

@@ -1,3 +1,4 @@
+// 该案例中延时了控制台服务器的实现，支持运行中根据控制台指令执行额外的功能逻辑
 package main
 
 import (

examples/simple-server-cross/doc.go

@@ -0,0 +1,2 @@
+// 该案例中演示了两个跨服相互通过网络进行数据传输的实现
+package main

examples/simple-server-echo/main.go

@@ -1,3 +1,4 @@
+// 该案例中实现了一个简单的回响服务器
 package main
 
 import (

game/builtin/doc.go

@@ -0,0 +1,2 @@
+// Package builtin 包含了通用游戏相关的接口的内置实现
+package builtin

notify/doc.go

@@ -0,0 +1,2 @@
+// Package notify 包含了对外部第三方通知的实现，如机器人消息等
+package notify

notify/notifies/doc.go

@@ -0,0 +1,2 @@
+// Package notifies 包含了内置通知内容的实现
+package notifies

notify/senders/doc.go

@@ -0,0 +1,2 @@
+// Package senders Package 包含了内置通知发送器的实现
+package senders

planner/configexport/doc.go

@@ -0,0 +1,2 @@
+// Package configexport 提供了XLSX配置转换为JSON及Go代码的导表工具实现
+package configexport

planner/doc.go

@@ -0,0 +1,2 @@
+// Package planner 包含了策划工具相关的内容
+package planner

report/doc.go

@@ -0,0 +1,2 @@
+// Package report 提供了对数据埋点及上报的实现
+package report

server/doc.go

@@ -0,0 +1,2 @@
+// Package server 提供了包含多种网络类型的服务器实现
+package server

utils/g2d/direction.go

@@ -1,12 +1,13 @@
 package g2d
 
+// Direction 方向
 type Direction uint8
 
 const (
-	DirectionUp = Direction(iota)
-	DirectionDown
-	DirectionLeft
-	DirectionRight
+	DirectionUp    = Direction(iota) // 上方
+	DirectionDown                    // 下方
+	DirectionLeft                    // 左方
+	DirectionRight                   // 右方
 )
 
 // CalcDirection 计算点2位于点1的方向