命名规范※
- 英文单词命名。禁止使用拼音或无意义的字母命名。
- 直观易懂。使用能够描述其功能或有意义的英文单词或词组。
- 不要采用下划线命名。
- 常量、静态字段、类、结构体、非私有字段、方法等名称采用大驼峰式命名法。
- 私有字段、方法形参、局部变量采用小驼峰式命名法。
- 私有字段以下划线开头。
- 接口命名以大写字母I开头。
- 枚举以大写字母E开头。
int car_type // 错误:下划线命名。
public const float MaxSpeed = 100f; // 常量
public static float MaxSpeed = 100f; // 静态字段
public class GameClass; // 类名
public struct GameStruct; // 结构体
public string FirstName; // public字段
protected string FirstName; // protected字段
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隔开。
- 方法内的代码块注释。
/// <summary>
/// 设置场景名称
/// </summary>
/// <param name=“sceneName”>场景名</param>
/// <retuens>如果设置成功返回TRUE</returns>
public bool SetSceneName(string sceneName)
{
}