崽崽ZEPETO 世界项目规范文档1- 命名规范

写在前面

为了减少沟通成本,统一研发、美术规范,以便提高工作效率。
整理崽崽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目录命名规范

image.png
列举常用文件名,如有其他按照通用规范添加;
  • 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工程子目录命名规范

image.png

image.png
  • 根据模块划分类整理 ,特定文件夹 有利于资源打包
  • 避免整体堆放,混乱;

写在最后

 #成功的道路没有捷径,保持初心,奋力前进。
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 简介 Unity可寻址资源系统 可寻址资源系统提供了一种简单的方法通过“地址”加载资源。简化资源包的创建和部署的管...
    hh5460阅读 9,297评论 2 10
  • android开发者这么久,你是否真的了解android开发规范呢?本文转自https://www.jianshu...
    毹毹阅读 3,206评论 0 2
  • 1.项目结构 现在的MVP模式越来越流行。就默认采用了。如果项目比较小的话: app——Application A...
    黄海佳阅读 2,122评论 1 4
  • written by leo.wang Android代码开发规范 1 类声明 1.1 只有一个顶级 类声明每个顶...
    Poseidon_Wang阅读 663评论 0 0
  • 包名全部采用小写,不用下划线区分单词 主包名采用[公司性质].[公司名称].[项目名称]的命名方式 例如:翡翠教育...
    gyymz1993阅读 3,174评论 1 29