写在前面
为了减少沟通成本,统一研发、美术规范,以便提高工作效率。
整理崽崽ZEPETO-NewWorld通用规范,以及前人的一些宝贵经验。
命名规范
- 目录和脚本采用:驼峰命名法,见名知义,一目了然,降低阅读成本;
- 使用英文, !!!不要使用拼命命名和非通用缩写,例如youxi.cs,zuanshi.fbx,zs.png;
- 美术素材文件(anim, material, fbx),不强制大小写,但是要统一,避免大小写混用,可读性困难;
- 模型和依赖素材的名字保持一致,例如:gun.fbx, gun.texture, gun.matrial;
- 通用UI图标文件,添加尺寸,例如:nPlay48.png, nPlay32.png, 48/32表示width !!不要用play1.png, play2.png;
- TS 脚本文件名跟类名保持一致 !!!不要随意更改,也不使用 -,#等特殊字符;
- TS 脚本接口规范:接口前加I,例如:IUIEvent;
- TS 枚举类名,不要加Enum前后缀, 通用枚举脚本名可命名”GlobalEnum";
- TS 常量统一用大写,多个单词用”_"隔开,例如:APP_MAX_FPS;
- TS 属性,全局变量,局部变量,参数 按照规范格式即可(个人习惯不同,不做强制要求,但要求统一);
Unity工程root目录命名规范
列举常用文件名,如有其他按照通用规范添加;
- Animations : 动画文件;
- Common/Custom : 通用/个性化,NewWorld工程无法使用插件;
- Editor : Unity插件,各类工具,打包前建议删除;
- Effects: 特效;
- Fonts : 字体;
- Images: UI素材;
- Materials : 材质球;
- Models : Fbx模型;
- Prefabs: 预制体;
- Resources : 动态加载路径,也是方便测试使用,打包前建议删除
- Scenes : 场景;
- ScriptableObjects: 序列化对象;
- Scripts : ts 脚本;
- Shaders : 着色器;
- Sounds : 音效;
- Textures : 贴图;
- World.multiplay : 默认路径,多人沙盒服务器;
Unity工程子目录命名规范
- 根据模块划分类整理 ,特定文件夹 有利于资源打包
- 避免整体堆放,混乱;
写在最后
#成功的道路没有捷径,保持初心,奋力前进。