命名规范※
- 英文单词命名。禁止使用拼音或无意义的字母命名。
- 直观易懂。使用能够描述其功能或有意义的英文单词或词组。
- 不要采用下划线命名。
- 常量、静态字段、类、结构体、非私有字段、方法等名称采用大驼峰式命名法。
- 私有字段、方法形参、局部变量采用小驼峰式命名法。
- 私有字段以下划线开头。
- 接口命名以大写字母I开头。
- 枚举以大写字母E开头。
int car_type
public const float MaxSpeed = 100f;
public static float MaxSpeed = 100f;
public class GameClass;
public struct GameStruct;
public string FirstName;
protected string FirstName;
public void SendMesssage(string message); {}
private string _firstName;
public void FindFirstName(string firstName);
string firstName;
public interface IState;
public enum EGAmeType{Simple,Hard}
编码规范※
- 声明变量时,一行只声明一个变量。
- 类的字段声明统一放置于类的最前端。
- 一行代码长度不要超过屏幕宽度。如果超过了,将超过部分换行。
private string _firstName;
private string _lastName;
public class Student
{
private string _firstName;
private string _lastName;
public string GetFirstName()
}
注释规范※
- 公共方法注释,采用///形式自动产生XML标签格式的注释。包括方法介绍、参数含义、返回内容。私有方法可以不注释。
- 公共字段注释,采用///形式自动产生XML标签格式注释。
- 私有字段注释,注释位于代码后面,中间Space隔开。
- 方法内的代码块注释。
public bool SetSceneName(string sceneName)
{
}