Unity开发——C#代码规范

一、命名法

Pascal命名法：每个单词首字母大写。
Camel命名法：第一个单词首字母小写，其余单词首字母大写。

• 函数和类采用Pascal命名法。
• 局部变量和参数采用Camel命名法。
• 代码目录和文件采用Pascal命名法。

二、基本规范

函数用动词命名，其它的用名词或者形容词命名。

避免使用拼音

原则上避免使用拼音命名代码。

尽量避免缩写

尽量不要缩写名字，名字长没关系，尽可能描述清楚。

类型前缀

类和变量前一般不要加前缀。模板类型加前缀T，接口加前缀I，枚举加前缀E。

类型后缀

特殊类型可选加后缀。
List：可选加List后缀。
Dictionary：可选加Dict后缀。
delegate：加上后缀Event。

成员变量

类非公有非静态成员变量用m开头。比如mName。
类的公有成员变量大写开头，不需要加m前缀，尽量用属性代替公有变量。

静态变量

类的静态成员变量用s开头。
函数内的静态变量用s开头。

空格

［eg. “if (a == b)”］。

空行

1. 函数之间必须加空行。
2. 较长函数的代码块直接用空行分割。
3. 变量定义可以分块加空行分割。

行长度

每一行代码的行长度，建议不要超过110个字符或者说不超过屏幕宽度。如果超过这个长度，可以按照以下规则换行：

1. 在逗号后换行。
2. 在操作符前换行。
3. 第一条优先于第二条

函数长度

建议单个函数长度不要超过80行。越简短越好。
超过80行，可以考虑拆分函数重用代码。

类长度

单个类文件原则上不超过1000行。接近或者超过，考虑拆分类或者多个文件实现类。