Unity项目基本风格/规范

本文由 NRatel 历史笔记整理而来,如有错误欢迎指正。

一、代码风格规范

1、原则:主要以Unity 官方源码为准。(实际上,它内部似乎也不完全统一)。

Unity 源码(C# 部分):https://github.com/Unity-Technologies/UnityCsReference

UGUI 源码:https://github.com/Unity-Technologies/uGUI

2、个人风格应统一

不应/应少出现都是自己手写的,但多处不一样的风格

3、代码折叠后,应清晰整洁(重要!!!)(为了对外友好)(因为对接时大多无需关心具体实现)

1、类、字段和方法命名应精准

不怕长,只怕不精准

特别注意高频词汇,应加限定

2、字段统一都带公私有标识

3、段落有间距

二、代码严格性相关

1、严格/非严格权衡

开发环境下为严格模式,多断言,不容错

线上环境,应已基于充分测试,分情况重要的不容错,不重要的可容错(只容极小概率事件)

原则为:暴露错误并解决

2、枚举Switch

枚举 switch 必须跟 default

对于可能扩展的枚举 thorw NotImplementedException()

对于不再扩展的枚举 thorw NotSupportedException()

3、错误码处理

已知错误能处理尽处理

三、界面功能任务自检

1、拼界面完成(与效果图差异小)

应以效果图为衬底,仔细对比元素大小、位置、旋转、缩放、文本字号、颜色等。保证几乎无差异

注意有一些例外,一些 等距排列、居中放置(注意阴影、修饰等偏移)等情况,以计算数值为准,不必和效果图对齐

检查:将效果图按设计尺寸放在Panel内最顶层,调整透明度观察

2、客户端数据模块和界面功能正确(单机状态正确)(含边界条件)

3、前后端联调结束(含边界条件)

4、特效动画添加完整

5、红点添加完成

6、多语言处理完成(含:文字、图、预设组件、特效等)

7、适配处理完成(3种分辨率:设计+长屏+宽屏)

四、美术命名规范

和UI美术制定交付资源的命名规范

并在Unity内导入检查(只包含字母数字下划线)

或利用程序,按一定规则,将中文改名为英文名后,导入Unity(但可能有一些衍生问题)

五、注意MVC各部分职责

V 界面逻辑

可直接读 M,可调 C

M 数据逻辑{模块名}Model

不可读写调用 V 和 C

C 控制逻辑({模块名}Ctrl)

可直接读写 M 和 V

项目放置建议

{公司}/{Group}/${Project}

如:
Kunlun/ProjectA/ProjectA
Kunlun/ProjectA/LevelEditor

Kunlun/ProjectB/ProjectB
Kunlun/ProjectB/LevelEditor

相关推荐
2501_9307077815 小时前
使用C#代码使用条件格式为 Excel 隔行设置颜色
c#·excel
Liaiyang6618 小时前
# 自研 AST 容错初筛工具:横向评测 Django、PyTorch、TensorFlow 三大开源 Python 框架异常收容风险
python·测试工具·自动化·开源软件·代码规范·devops·代码复审
何以解忧唯有撸码19 小时前
【开源】c#造个轮子-日程安排工具
c#·自定义控件
周杰伦fans19 小时前
CAD菜单栏和工具栏都不见了,怎么显示?
其他·c#
曹牧19 小时前
C#:HashSet<T> 去重
c#
czhc114007566319 小时前
起点、口径与因果:今天用错的七把尺子
c#
小小数媒成员20 小时前
UGUI 性能优化(详细,全,深入)
开发语言·unity·游戏引擎
c#上位机1 天前
C#上位机项目实战——Task.Run执行带参数的方法
c#·上位机
林川~011 天前
Unity新输入系统使用笔记
unity·input system
Lost of 程序猿2 天前
用 YARP 为 .NET 微服务搭一座“立交桥“:路由转发与生产配置实践
c#·asp.net