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

相关推荐
张人玉21 分钟前
VsionMaster筛选机错误情况
数码相机·c#·通讯·网络通讯
Crazy Struggle3 小时前
告别人工干预!C# 轻量级上位机自动联动 MES 与视觉检测
c#·.net·mes
LateFrames3 小时前
做【秒开】的程序:WPF / WinForm / WinUI3 / Electron
electron·c#·wpf·winform·winui3·claude code
想拿大厂offer4 小时前
Windows Server 2022 + IIS + .NET 8 + MySQL 部署手册
c#·asp.net
lrh30255 小时前
Custom SRP - 14 Multiple Cameras
unity·渲染管线·srp
JaneHe6 小时前
最新Eslint9+prettier+Husky暂存区配置(基于Vue)
代码规范
小码编匠6 小时前
.NET 10 性能突破:持续优化才是质变关键
后端·c#·.net
UIUV7 小时前
Ajax 数据请求学习笔记
前端·javascript·代码规范
mudtools9 小时前
.NET驾驭Excel之力:Excel应用程序的创建与管理
c#·.net·excel·wps
mudtools9 小时前
.NET驾驭Excel之力:自动化数据处理 - 开篇概述与环境准备
c#·自动化·.net·excel·wps