Files
Fishing2Server/Tools/SourceCode/Fantasy.Tools.NetworkProtocol/NetworkProtocolTemplate.README.md
2025-10-29 17:59:43 +08:00

1.5 KiB
Raw Blame History

NetworkProtocolTemplate.txt 使用说明

概述

这个模板文件用于生成网络协议的 C# 代码文件。您可以根据需要自定义模板内容。

占位符说明

模板中包含以下占位符,会在代码生成时被替换:

(UsingNamespace)

  • 用于插入自定义命名空间的 using 语句
  • 例如:当使用自定义序列化器时,会在此处插入相关的 using 语句

(Content)

  • 用于插入生成的协议类代码
  • 所有 message 定义都会被转换为 C# 类并插入到此处

模板结构

服务端部分(#if SERVER

包含服务端特有的引用和配置:

  • using MongoDB.Bson.Serialization.Attributes - 用于 MongoDB 持久化
  • 额外的编译器指令和 ReSharper 配置

客户端部分(#else

包含客户端需要的基本引用:

  • 较少的 using 语句
  • 简化的警告抑制

自定义方法

如果需要修改生成的代码格式,可以:

  1. 修改 using 语句部分
  2. 添加或删除编译器指令
  3. 修改命名空间结构
  4. 添加全局特性或注释

注意事项

⚠️ 不要删除占位符(UsingNamespace)(Content) 是必需的,删除会导致代码生成失败

⚠️ 保持条件编译#if SERVER / #else / #endif 结构用于区分服务端和客户端代码

⚠️ 编码格式:文件应使用 UTF-8 编码

文件位置

编译后,模板文件会被复制到输出目录,确保与可执行文件在同一位置。