任何标识符的名字都应该可以简单、清楚、正确的表示出该标识符的作用。同时我们要将尽可能多的信息装入到标识符的名字当中去,以便读代码的人可以快速的读懂代码。
PascalCasing(帕斯卡命名法)
PascalCasing包含一到多个单词,每一个单词第一个字母大写,其余字母均小写。例如:HelloWorld、UserName等。
所有命名空间名称、类、接口、函数、属性、枚举等名称的命名,使用 Pascal 风格。
//命名空间
namespace Soft.Service
//类
public class UserService
//接口
public interface IUserService
//函数
public string GetUser()
//属性
public string UserName { get; set; }
//枚举
public enum StockTypeEnum
camelCasing(驼峰命名法)
camelCasing包含一到多个单词,第一个单词首字母小写,其余单词首字母大写。例如:name、productID等。
参数与变量的命名使用camelCasing.
//参数
public string GetUser(int id)
//变量
var name = "xyc";
var user = new User();
UPPER_CAPS
UPPER_CAPS包含一到多个单词,每个单词的所有字母都大写,单词与单词之间用”_”连接。
该风格目前在c#中只用于const常量。
//常量
public const string MAX_VALUE = "1000";
私有变量的命名
Private 的私有变量使用下划线”_”+camelCasing的大小写规则,以便快速确认该变量的作用域。
//私有变量
private int _userId;
首字母缩写词的大小写
首字母缩写词是由一个短语的首字母组成的,如Xml(ExtensibleMarkuLaguage),IO(Input and Output)。它和单词缩写是有区别的,单词缩写仅仅是把一个单词的长度变短。
a. 把两个字母的首字母缩写词全部大写,除非它是camelCasing的第一个单词。
//两个字母缩写
using System.IO;
public void StartIO(Stream ioStream)
b. 由三个或以上的字母组成的首字母缩写词,只有第一个字母大写,如Xml,Html.除非首字母是camelCasing标识符的第一个单词。
//三个以上个字母缩写
using System.Xml;
public void ProcessXmlNode(XmlNode xmlNode)
复合词的大小写
不要把复合词中的首字母大写,复合词本身就是一个单词,复合词要当成一个单词来处理。