总原则
直接使用visualstudio默认设置来编码, ctrl+K, F 来执行格式化代码
大括号换行, 缩进采用4空格替换tab
1.命名规则
1.1命名的基本约定
PasalCasing:标识符的第一个单词的字母大写;
camelCasing:标识符的第一个单词的字母小写。
标识符 | 大小写 | 示例 |
---|---|---|
命名空间 | Pascal | namespace Com.Techstar.ProductionCenter |
类型 | Pascal | public class DevsList |
接口 | Pascal | public interface ITableModel |
方法 | Pascal | public void UpdateData() |
属性 | Pascal | Public int Length{…} |
事件 | Pascal | public event EventHandler Changed; |
私有字段 | Camel | private string fieldName; |
非私有字段 | Pascal | public string FieldName; |
枚举值 | Pascal | FileMode{Append} |
参数 | Camel | public void UpdateData(string fieldName) |
局部变量 | Camel | string fieldName; |
避免使用缩写,如果一定要使用,就谨慎使用。同时,应该保留一个标准缩写的列表,并且在使用时保持一致。
避免使用相似或者仅在大小写上有区别的名字
可以带上数据类型: 例如int iAge;
备注示例代码
namespace SevenShine
{
public class SSSendMessage
{
//私有变量区
private int _field1;
private int _field2;
//保护变量区
protect int _field3;
protect int _field4;
//UNITY3D设置的变量是公用的
public int BulletNum;
//公用变量可以属性化
public string FileName { get; set; };
public float FileSize { get; set; };
//构造函数 复杂的在上面,简单的在下面, 如下图
public SSSendMessage(int p1, int p2){};
public SSSendMessage(int p1){};
public SSSendMessage(){};
/// <summary>
/// 取消所有指定消息的监听
/// </summary>
public static void ClearALLMsgListener()
{
if (_dicMessages != null)
{
_dicMessages.Clear();
}
}
}
}