自用命名规范
2022-03-31 本文已影响0人
搬凳子游戏个人开发者
UI命名规范
普通UI命名
- 控件类型_ui名称
node_main
label_name
sprite_role
scrollview_list
layout_panel
UI绑定脚本命名
- 控件类型简称_ui绑定脚本名称_bind
label_MainPanel_bind
文件规范
- 文件夹小写,多个单词加 -
assets-manager
- 类名,大驼峰法
DataBaseUser
- 私有属性,方法加 _名称,小驼峰法
private _nickName;
private _getNickName(): void {}
- 子类或外部可访问为名称,小驼峰法
public nickName;
protect playerAge;
public getNickName(): void {}
-
常量
使用大写字母,并且指出该常量完整含义。如果一个常量名称由多个单词组成,则应该用下划线来分割这些单词
MAX_VALUE
-
参数的命名
参数的命名规范和方法的命名规范相同,而且为了避免阅读程序时造成迷惑,请在尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确。不是必传参数增加 _参数名
private _setData(userName: string, _age = 20): void {}
-
接口的命名
接口名称都加上前缀“I”。
接口名称在前缀之后的部分命名规则与类相同。
根据接口类型可以在之后加上业务类型的头等。
IRunnable
ISingleton
- 其他命名
数组 xxxArr;
json表 xxxInfo;
controller[控制层]:UserController.ts
module[业务逻辑]:SettingModule.ts
data[数据定义类]:data/UserInfo.ts
interface[业务逻辑接口层]:IUserService.ts
common[公共层]:util.ts