命名&开发规范

引言

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

术语解释

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

规范内容

• 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