ET框架终极API文档编写指南：打造专业插件开发规范-优快云博客

ET框架终极API文档编写指南：打造专业插件开发规范

ET框架作为一款强大的Unity3D客户端和C#服务器框架，为开发者提供了完整的游戏开发解决方案。掌握ET框架插件开发规范，特别是API文档编写技巧，是提升插件质量和用户体验的关键。本文将为你详细介绍ET框架插件文档编写的最佳实践和规范要求。🚀

ET Package是标准的Unity Package，遵循特定的目录结构和命名规范。每个包的目录格式必须是cn.etetet.+包名，例如cn.etetet.core。这种命名规范确保了包的唯一性和可识别性。

该目录放置Model、Hotfix、ModelView、HotfixView代码，这些代码在Unity中可热更新。子目录结构包含Server、Client、Share，分别表示在服务端、客户端、双端生效的代码。

该目录放置AOT代码，里面必须定义asmdef程序集，一般以ET.Core这种格式命名。这是确保代码正确组织和编译的关键。

该目录用来放置Excel表格，ExcelExporter工具会扫描这个目录，导出代码到cn.etetet.excel包中。导出配置放在ET/Config/Excel中，其中json格式放在ET/Config/Json中。

该目录放置消息定义，Proto2CS工具会扫描这个目录，生成代码在cn.etetet.proto包中。这是实现前后端通信的基础。

在编写ET框架插件时，必须为每个公共类、方法和属性添加详细的XML注释。这不仅有助于其他开发者理解代码功能，还能在IDE中提供智能提示。

每个功能模块都应提供清晰的示例代码，展示如何正确使用API。示例代码应该包含完整的初始化、使用和清理流程。

将文档按功能模块进行组织，确保每个模块都有明确的功能说明、使用方法和注意事项。

每个ET Package都应该在package.json中明确版本号，遵循语义化版本控制规范。这有助于用户了解插件的兼容性和更新内容。

如果包需要依赖其它git包，例如memorypack，可以在packagegit.json文件中的GitDependencies项添加依赖关系。

为防止包下载后立即生效导致错误，需要为Model、ModelView、Hotfix、HotfixView四个asmdef加上INITED宏。只有在运行ET->Init后才会加上INITED宏，这样四个程序集才会正确生效。

为了让自定义菜单简洁统一，Package自定义的菜单使用"ET->Package名->具体功能"这种风格，例如ET->Loader->Init。

为了控制打包裁剪问题，可以在包目录放置一个link.xml文件，init的时候会把link.xml链接到Assets目录，因为Unity只扫描Assets中的link.xml。

通过遵循这些ET框架插件文档编写规范，你不仅能创建出高质量的插件，还能为其他开发者提供清晰的使用指导。记住，好的文档是优秀插件的重要组成部分！✨

创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考