命名&开发规范

引言

良好的命名规范,可以提升代码的整洁性、可读性,对于项目后期的维护可以 更快的理解代码的内容。尤其在团队开发中,大家采用约定方式去开发代码, 可以保证项目整体的可读性提高协作效率。


术语解释
  • 小驼峰命名法
    变量一般用小驼峰法标识。驼峰法的意思是:除第一个单词之外,其他单词首字母大写
  • 大驼峰命名法
    相比小驼峰法,大驼峰法把第一个单词的首字母也大写了。常用于类名,命名空间等
  • 下划线命名法
    如果一个变量或函数名字由一个或者多个单词组成,用下划线对不同的单词进行间隔,就形成下划线命名法,单词可以全部小写,也可以全部大写

规范内容
  • GameObject
    • Prefab
      采用 大驼峰 命名法,例如 HelloWorld
    • 资源文件
      • AssetBundle
        采用全小写字母的 下划线命名法 并且文件后缀名为 ab 例如 hello_world.ab, 因为在Unity中ab文件名是不能有大写字母的
      • 其它文件
        采用全小写字母的 下划线命名法 和AB资源匹配,这样保证所有的资源有统一的命名规则
    • 命名空间
      采用 大驼峰 命名法,例如 namespace HelloWorld 最好以模块为单位来划分命名空间
    • 类名
      采用 大驼峰 命名法, 并且类名和文件名相同, 例如 public class HelloWorld
    • 方法
      采用 大驼峰 命名法,例如 public static void HelloWorld()
    • 公共变量
      采用 小驼峰 命名法, 例如 public string helloWorld
    • 私有变量
      采用 小驼峰 命名法, 但是第一个字符以下划线开始, 例如 private string _helloWorld
    • 常量
      采用全大写字母的 下划线命名法 ,例如 public const int MAX_VALUE
    • 单例
      单例统一命名为 Ins 采用 get 封装的拾取器,例如 HelloWorld.ins
  • 全局
    • 变量
      采用 小驼峰 命名法, 例如 public static string helloWorld
    • 常量
      采用全大写字母的 下划线命名法 ,例如 public const int MAX_VALUE
    • 方法
      采用 大驼峰 命名法,例如 public static void HelloWorld()
  • 框架约定
    • 数据结构
      在变量名的结尾加上数据结构的类型。如果我们的数据对象是List,那么我们在命名这个变量的时候可以叫xxxList,例如我们有一个私有的好友列表属性,那么可以叫 _friendList
    • 组件
      在变量名的开头加上组件名称的缩写。例如我们有一个负责登录的Button组件,我们对它的公共引用变量就叫做 btnLogin,组件在「Inspector」中的名称则采用 大驼峰 叫做 BtnLogin
    • 窗体
      窗体指的是在屏幕中可以出现多个的弹窗页面,我们通常在名称的结尾加上 Win 来对它进行标识,例如登录窗口我们就叫 LoginWin
    • 舞台
      舞台指的是在屏幕中同一时间只会有一个的页面,我们通常在名称的结尾加上 Stage 来对它进行标识,例如游戏的大厅场景我们就叫 HallStage
    • 委托
      在委托的开头加上 On ,委托对应的方法前也加上 On,例如 public delegate void OnHelloWorld()
    • 事件
      事件名称以 Event 结尾,例如 HelloWorldEvent
    • 通知
      通知名称以 Notice 结尾,例如 HelloWorldNotice
    • 数据对象
      游戏中我们通常定义的只有数据(不含任何业务逻辑)的结构体,我们以 VO 结尾来标识它,例如 HelloWorldVO
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,425评论 4 361
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,058评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,186评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,848评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,249评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,554评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,830评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,536评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,239评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,505评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,004评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,346评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,999评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,060评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,821评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,574评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,480评论 2 267

推荐阅读更多精彩内容

  • Android编码规范 源文件基础 文件名 源文件以其最顶层的类名来命名,大小写敏感,文件扩展名为.java。 文...
    呼呼哥阅读 872评论 0 0
  • 前言 说是前言,其实也是本文诞生的目的。随着公司业务的不断增加,功能的快速迭代,app的业务线越来越多,代码体积变...
    Yealink阅读 5,150评论 0 13
  • 成电生命科学院, 晶体成功我有感。 成电建校六十年, 好事接连捷报传, 说是生命科学院, 晶体合成算一件。 时间过...
    端阳五月五阅读 134评论 0 1
  • 白鹿原位于西安市郊,跨长安(县)、灞桥(区)、蓝田(县)的灞河、浐河之间,东起篑山,西到西安,南依秦岭终南山,总长...
    渺尘03阅读 351评论 0 1
  • 对于工作一直没有太多的想法,一直处于迷茫中,今天CPA的六门教材都已经收到了,看了看目录觉得自己是可以,是有能力考...
    月光的微笑阅读 478评论 2 2