refactor(docs): 清理代码注释中的冗余Java对应说明

This commit is contained in:
1
2025-08-26 23:22:10 +00:00
parent e129e82a8d
commit 5ba6f1b8ef
11 changed files with 42 additions and 42 deletions

View File

@@ -131,7 +131,7 @@ func genMonster(id uint32) maps.OgreInfo {
return t1 return t1
} }
// 计算整数的二进制1的个数对应Java的Integer.bitCount // 计算整数的二进制1的个数Integer.bitCount
func bitsCount(n int) int { func bitsCount(n int) int {
count := 0 count := 0
for n > 0 { for n > 0 {

View File

@@ -8,7 +8,7 @@ import (
type FightNpcMonsterInboundInfo struct { type FightNpcMonsterInboundInfo struct {
Head handler.TomeeHeader `cmd:"2408" struc:"[0]pad"` Head handler.TomeeHeader `cmd:"2408" struc:"[0]pad"`
// Number 地图刷新怪物结构体对应的序号1-9的位置序号 // Number 地图刷新怪物结构体对应的序号1-9的位置序号
// 对应Java的@UInt long类型使用uint32保持无符号特性 // @UInt long类型使用uint32保持无符号特性
Number uint32 `fieldDesc:"地图刷新怪物结构体对应的序号 1 - 9 的位置序号" ` Number uint32 `fieldDesc:"地图刷新怪物结构体对应的序号 1 - 9 的位置序号" `
} }
@@ -21,7 +21,7 @@ type ReadyToFightInboundInfo struct {
} }
type FightStartOutboundInfo struct { type FightStartOutboundInfo struct {
// 对应Java的@UInt long类型 // @UInt long类型
IsCanAuto uint32 `fieldDesc:"是否自动 默认给0 怀疑是自动战斗器使用的" ` IsCanAuto uint32 `fieldDesc:"是否自动 默认给0 怀疑是自动战斗器使用的" `
// 当前战斗精灵信息1前端通过userid判断是否为我方 // 当前战斗精灵信息1前端通过userid判断是否为我方
@@ -31,34 +31,34 @@ type FightStartOutboundInfo struct {
Info2 FightPetInfo `fieldDesc:"当前战斗精灵的信息 可能不准.看前端代码是以userid来判断哪个结构体是我方的" serialize:"struct"` Info2 FightPetInfo `fieldDesc:"当前战斗精灵的信息 可能不准.看前端代码是以userid来判断哪个结构体是我方的" serialize:"struct"`
} }
// FightPetInfo 战斗精灵信息结构体,对应Java的FightPetInfo类 // FightPetInfo 战斗精灵信息结构体FightPetInfo类
type FightPetInfo struct { type FightPetInfo struct {
// 用户ID野怪为0对应Java的@UInt long // 用户ID野怪为0@UInt long
UserID uint32 `fieldDesc:"用户ID 野怪为0" ` UserID uint32 `fieldDesc:"用户ID 野怪为0" `
// 当前对战精灵ID对应Java的@UInt long // 当前对战精灵ID@UInt long
PetID uint32 `fieldDesc:"当前对战精灵ID" ` PetID uint32 `fieldDesc:"当前对战精灵ID" `
// 空的16字节byte对应Java的固定长度字符串 // 空的16字节byte固定长度字符串
// 使用[16]byte匹配固定长度16字节的要求 // 使用[16]byte匹配固定长度16字节的要求
PetName [16]byte `fieldDesc:"空的16字节byte" serialize:"fixedLength=16,type=byteArray"` PetName [16]byte `fieldDesc:"空的16字节byte" serialize:"fixedLength=16,type=byteArray"`
// 精灵的捕获时间,对应Java的@UInt long // 精灵的捕获时间,@UInt long
CatchTime uint32 `fieldDesc:"精灵的捕获时间" ` CatchTime uint32 `fieldDesc:"精灵的捕获时间" `
// 当前HP对应Java的@UInt long // 当前HP@UInt long
Hp uint32 `fieldDesc:"当前HP" ` Hp uint32 `fieldDesc:"当前HP" `
// 最大HP对应Java的@UInt long // 最大HP@UInt long
MaxHp uint32 `fieldDesc:"最大HP" ` MaxHp uint32 `fieldDesc:"最大HP" `
// 当前等级,对应Java的@UInt long // 当前等级,@UInt long
Level uint32 `fieldDesc:"当前等级" ` Level uint32 `fieldDesc:"当前等级" `
// 精灵是否能捕捉1为能捕捉0为不能捕捉对应Java的@UInt long // 精灵是否能捕捉1为能捕捉0为不能捕捉@UInt long
Catchable uint32 `fieldDesc:"精灵是否能捕捉. 1为能捕捉 0为不能捕捉" ` Catchable uint32 `fieldDesc:"精灵是否能捕捉. 1为能捕捉 0为不能捕捉" `
// 战斗属性等级数组6个单字节 // 战斗属性等级数组6个单字节
// 对应Java的byte[]固定长度6存储buff等级、攻击、速度等属性 // byte[]固定长度6存储buff等级、攻击、速度等属性
BattleLV [6]byte `fieldDesc:"这里实际上应该是6个单字节byte, 内容为buff等级 攻击 速度 特攻 防御 特防 命中等.但具体顺序未知可能需要测试. 具体数值为1-6等级" serialize:"fixedLength=6,type=byteArray"` BattleLV [6]byte `fieldDesc:"这里实际上应该是6个单字节byte, 内容为buff等级 攻击 速度 特攻 防御 特防 命中等.但具体顺序未知可能需要测试. 具体数值为1-6等级" serialize:"fixedLength=6,type=byteArray"`
} }

View File

@@ -5,7 +5,7 @@ import (
) )
type FightUserInfo struct { type FightUserInfo struct {
// 用户ID野怪为0对应Java的@UInt long // 用户ID野怪为0@UInt long
UserID uint32 `fieldDesc:"userID 如果为野怪则为0" ` UserID uint32 `fieldDesc:"userID 如果为野怪则为0" `
// 玩家名称野怪为UTF-8的'-'固定16字节 // 玩家名称野怪为UTF-8的'-'固定16字节
@@ -13,19 +13,19 @@ type FightUserInfo struct {
Nickname [16]byte ` ` Nickname [16]byte ` `
} }
// NoteReadyToFightInfo 战斗准备就绪消息结构体,对应Java的NoteReadyToFightInfo // NoteReadyToFightInfo 战斗准备就绪消息结构体NoteReadyToFightInfo
type NoteReadyToFightInfo struct { type NoteReadyToFightInfo struct {
//战斗发起者ID //战斗发起者ID
OwnerID uint32 `struc:"skip"` OwnerID uint32 `struc:"skip"`
// 战斗类型ID与野怪战斗为3与人战斗为1前端似乎未使用 // 战斗类型ID与野怪战斗为3与人战斗为1前端似乎未使用
// 对应Java的@UInt long // @UInt long
FightId uint32 `fieldDesc:"战斗类型ID 但前端好像没有用到 与野怪战斗为3与人战斗似乎是1" ` FightId uint32 `fieldDesc:"战斗类型ID 但前端好像没有用到 与野怪战斗为3与人战斗似乎是1" `
// 我方信息 // 我方信息
OurInfo FightUserInfo `fieldDesc:"我方信息" serialize:"struct"` OurInfo FightUserInfo `fieldDesc:"我方信息" serialize:"struct"`
OurPetListLen uint32 `struc:"sizeof=OurPetList"` OurPetListLen uint32 `struc:"sizeof=OurPetList"`
// 我方携带精灵的信息 // 我方携带精灵的信息
// 对应Java的ArrayList<ReadyFightPetInfo>,使用切片模拟动态列表 // ArrayList<ReadyFightPetInfo>,使用切片模拟动态列表
OurPetList []ReadyFightPetInfo `fieldDesc:"我方携带精灵的信息" serialize:"lengthFirst,lengthType=uint16,type=structArray"` OurPetList []ReadyFightPetInfo `fieldDesc:"我方携带精灵的信息" serialize:"lengthFirst,lengthType=uint16,type=structArray"`
// 对方信息 // 对方信息
@@ -36,34 +36,34 @@ type NoteReadyToFightInfo struct {
OpponentPetList []ReadyFightPetInfo `fieldDesc:"敌方的精灵信息 如果是野怪 那么再给客户端发送这个包体时就提前生成好了这只精灵的PetInfo,然后把从PetInfo中把部分信息写入到这个敌方的精灵信息中再发送这个包结构体" serialize:"lengthFirst,lengthType=uint16,type=structArray"` OpponentPetList []ReadyFightPetInfo `fieldDesc:"敌方的精灵信息 如果是野怪 那么再给客户端发送这个包体时就提前生成好了这只精灵的PetInfo,然后把从PetInfo中把部分信息写入到这个敌方的精灵信息中再发送这个包结构体" serialize:"lengthFirst,lengthType=uint16,type=structArray"`
} }
// ReadyFightPetInfo 准备战斗的精灵信息结构体,对应Java的ReadyFightPetInfo类 // ReadyFightPetInfo 准备战斗的精灵信息结构体ReadyFightPetInfo类
type ReadyFightPetInfo struct { type ReadyFightPetInfo struct {
// 精灵ID对应Java的@UInt long // 精灵ID@UInt long
ID uint32 `fieldDesc:"精灵ID" ` ID uint32 `fieldDesc:"精灵ID" `
// 精灵等级,对应Java的@UInt long // 精灵等级,@UInt long
Level uint32 `fieldDesc:"精灵等级" ` Level uint32 `fieldDesc:"精灵等级" `
// 精灵当前HP对应Java的@UInt long // 精灵当前HP@UInt long
Hp uint32 `fieldDesc:"精灵HP" ` Hp uint32 `fieldDesc:"精灵HP" `
// 精灵最大HP对应Java的@UInt long // 精灵最大HP@UInt long
MaxHp uint32 `fieldDesc:"最大HP" ` MaxHp uint32 `fieldDesc:"最大HP" `
SkillListLen uint32 SkillListLen uint32
// 技能信息列表固定4个元素技能ID和剩余PP无技能则为0 // 技能信息列表固定4个元素技能ID和剩余PP无技能则为0
// 对应Java的List<SkillInfo>初始化容量为4 // List<SkillInfo>初始化容量为4
SkillList [4]model.SkillInfo `fieldDesc:"技能信息 技能ID跟剩余PP 固定32字节 没有给0" serialize:"fixedLength=4,type=structArray"` SkillList [4]model.SkillInfo `fieldDesc:"技能信息 技能ID跟剩余PP 固定32字节 没有给0" serialize:"fixedLength=4,type=structArray"`
// 精灵捕获时间,对应Java的@UInt long // 精灵捕获时间,@UInt long
CatchTime uint32 `fieldDesc:"精灵捕获时间" ` CatchTime uint32 `fieldDesc:"精灵捕获时间" `
// 捕捉地图固定给0对应Java的@UInt long // 捕捉地图固定给0@UInt long
CatchMap uint32 `fieldDesc:"捕捉地图 给0" ` CatchMap uint32 `fieldDesc:"捕捉地图 给0" `
// 固定给0对应Java的@UInt long // 固定给0@UInt long
CatchRect uint32 `fieldDesc:"给0" ` CatchRect uint32 `fieldDesc:"给0" `
// 固定给0对应Java的@UInt long // 固定给0@UInt long
CatchLevel uint32 `fieldDesc:"给0" ` CatchLevel uint32 `fieldDesc:"给0" `
SkinID uint32 `fieldDesc:"精灵皮肤ID" ` SkinID uint32 `fieldDesc:"精灵皮肤ID" `
Shiny uint32 `fieldDesc:"精灵是否闪" ` Shiny uint32 `fieldDesc:"精灵是否闪" `

View File

@@ -5,9 +5,9 @@ import "blazing/common/socket/handler"
type CreatePlayerInboundInfo struct { //这里直接使用组合来实现将传入的原始头部数据和结构体参数序列化 type CreatePlayerInboundInfo struct { //这里直接使用组合来实现将传入的原始头部数据和结构体参数序列化
Head handler.TomeeHeader `cmd:"108" struc:"[0]pad"` //玩家登录 Head handler.TomeeHeader `cmd:"108" struc:"[0]pad"` //玩家登录
// 玩家昵称,对应Java的@ArraySerialize注解 // 玩家昵称,@ArraySerialize注解
Nickname string `struc:"[16]byte"` // 固定长度16字节 Nickname string `struc:"[16]byte"` // 固定长度16字节
// 机器人人物颜色 rgb对应Java的@UInt注解 // 机器人人物颜色 rgb@UInt注解
Color uint32 `fieldDescription:"机器人人物颜色 rgb" uint:"true"` Color uint32 `fieldDescription:"机器人人物颜色 rgb" uint:"true"`
} }
type CreatePlayerOutInfo struct { type CreatePlayerOutInfo struct {

View File

@@ -35,7 +35,7 @@ func (t *InInfo) Broadcast(mapid uint32, o OutInfo) {
// 这里存储星球的map // 这里存储星球的map
//var planetmap utils.SyncMap[] //= space.NewSyncMap() //var planetmap utils.SyncMap[] //= space.NewSyncMap()
// PeopleInfo 对应Java的PeopleInfo类实现OutboundMessage接口 // PeopleInfo PeopleInfo类实现OutboundMessage接口
type OutInfo struct { type OutInfo struct {
UserID uint32 `struc:"uint32" fieldDesc:"米米号" json:"user_id"` UserID uint32 `struc:"uint32" fieldDesc:"米米号" json:"user_id"`

View File

@@ -16,14 +16,14 @@ type FitmentShowInfo struct {
Status uint32 `json:"status"` Status uint32 `json:"status"`
} }
// FitmentUseringInboundInfo 对应Java的FitmentUseringInboundInfo类实现InboundMessage接口 // FitmentUseringInboundInfo FitmentUseringInboundInfo类实现InboundMessage接口
type FitmentUseringInboundInfo struct { type FitmentUseringInboundInfo struct {
Head handler.TomeeHeader `cmd:"10006" struc:"[0]pad"` //玩家登录 Head handler.TomeeHeader `cmd:"10006" struc:"[0]pad"` //玩家登录
// 需要获取基地信息的目标玩家账号ID // 需要获取基地信息的目标玩家账号ID
TargetUserID uint32 `json:"targetUserId"` TargetUserID uint32 `json:"targetUserId"`
} }
// FitmentUseringOutboundInfo 对应Java的FitmentUseringOutboundInfo实现OutboundMessage接口 // FitmentUseringOutboundInfo FitmentUseringOutboundInfo实现OutboundMessage接口
type FitmentUseringOutboundInfo struct { type FitmentUseringOutboundInfo struct {
// 玩家账号ID // 玩家账号ID
UserId uint32 ` json:"userId"` UserId uint32 ` json:"userId"`

View File

@@ -8,7 +8,7 @@ import (
type InInfo struct { type InInfo struct {
Head handler.TomeeHeader `cmd:"2101" struc:"[0]pad"` //走路包 Head handler.TomeeHeader `cmd:"2101" struc:"[0]pad"` //走路包
// Flag: 0为走1为飞行模式对应Java的@UInt long // Flag: 0为走1为飞行模式@UInt long
Flag uint32 Flag uint32
// Point: 直接给坐标xy // Point: 直接给坐标xy
@@ -32,7 +32,7 @@ func (t *InInfo) Broadcast(mapid uint32, o OutInfo) {
}) })
} }
// PeopleWalkOutboundInfo 对应Java的PeopleWalkOutboundInfo类实现OutboundMessage接口 // PeopleWalkOutboundInfo PeopleWalkOutboundInfo类实现OutboundMessage接口
type OutInfo struct { type OutInfo struct {
// Flag: 0为走1为飞行模式 // Flag: 0为走1为飞行模式
Flag uint32 `fieldDesc:"0为走1为飞行模式" codec:"uint"` Flag uint32 `fieldDesc:"0为走1为飞行模式" codec:"uint"`

View File

@@ -13,7 +13,7 @@ type InInfo struct { //这里直接使用组合来实现将传入的原始头部
// OutInfo 表示系统时间的出站消息 // OutInfo 表示系统时间的出站消息
type OutInfo struct { type OutInfo struct {
SystemTime uint32 `json:"systemTime"` // 对应Java的@UInt long类型 SystemTime uint32 `json:"systemTime"` // @UInt long类型
} }
// NewOutInfo 创建新的系统时间消息实例 // NewOutInfo 创建新的系统时间消息实例

View File

@@ -23,8 +23,8 @@ func (t *TeamInfo) InitDefaults() {
// TeamPKInfo 战队PK相关信息结构 // TeamPKInfo 战队PK相关信息结构
type TeamPKInfo struct { type TeamPKInfo struct {
GroupID uint32 `struc:"uint32" default:"1"` // 分组ID默认值1对应Java的@UInt long GroupID uint32 `struc:"uint32" default:"1"` // 分组ID默认值1@UInt long
HomeTeamID uint32 `struc:"uint32" default:"1"` // 主队ID默认值1对应Java的@UInt long HomeTeamID uint32 `struc:"uint32" default:"1"` // 主队ID默认值1@UInt long
} }
// InitDefaults 初始化默认值(确保字段默认值正确赋值) // InitDefaults 初始化默认值(确保字段默认值正确赋值)

View File

@@ -115,10 +115,10 @@ type PetEffectInfo struct {
Reserve4 [13]byte `struc:"[13]byte" json:"reserve4"` Reserve4 [13]byte `struc:"[13]byte" json:"reserve4"`
} }
// SkillInfo 精灵技能信息结构(对应Java的SkillInfo // SkillInfo 精灵技能信息结构SkillInfo
type SkillInfo struct { type SkillInfo struct {
ID uint32 `struc:"uint32"` // 技能id对应Java的@UInt long ID uint32 `struc:"uint32"` // 技能id@UInt long
Pp uint32 `struc:"uint32"` // 剩余pp对应Java的@UInt long Pp uint32 `struc:"uint32"` // 剩余pp@UInt long
} }
// TableName Pet's table name // TableName Pet's table name

View File

@@ -18,10 +18,10 @@ type Pos struct {
Y uint32 `struc:"uint32" default:"0"` Y uint32 `struc:"uint32" default:"0"`
} }
// PeopleItemInfo 穿戴装备信息结构(对应Java的PeopleItemInfo // PeopleItemInfo 穿戴装备信息结构PeopleItemInfo
type PeopleItemInfo struct { type PeopleItemInfo struct {
ID uint32 `struc:"uint32"` // 装备id ID uint32 `struc:"uint32"` // 装备id
Level uint32 `struc:"uint32" default:"1"` // 未知字段默认值1对应Java的@Builder.Default Level uint32 `struc:"uint32" default:"1"` // 未知字段默认值1@Builder.Default
} }
// InitDefaults 初始化默认值(确保默认值正确赋值) // InitDefaults 初始化默认值(确保默认值正确赋值)