C#命名规范

该文是作者对微软文档的见解,更多详细信息请参照原文档

标识符 (变量)

· 标识符必须以字母或下划线(_)开头

· 标识符可以包含 Unicode 字母字符、十进制数字字符、Unicode 连接字符、Unicode 组合字符或 Unicode 格式字符。

· 你可以在关键字前加'@',声明一个与关键字相同的变量,例如:@if 是变量 if。我个人不太建议这么做。

命名约定

在介绍命名约定之前,我将先介绍Pascal Case 和 Camel Case

Pascle Case

形如 DataChecker, ValueCoordinate 之类的命名。将单词间空格删去,所有首字母大写,即是Pascle Case

Camel Case

Camel Case,又称驼峰法,与Pascal Case及其类似,只是第一个字母不在大写,例如dataChecker, valueCoordinate

True 命名约定

public interface IMyInterface               //接口使用I作为开头,其余部分使用Pascle命名法
{
    public void MyMethod();                 //方法使用Pascle命名法
}

public class MyAttribute : Attribute { }    //特性使用Attribute结尾,其余部分使用Pascle命名法

public class MyClass : IMyInterface
{
    private readonly int _myVal = 256;      //私有变量以_开头,其余部分使用Camel命名法

    public void MyMethod()
    {
        const int MyVal = 1024;             //常量使用Pascle命名法
        int localVar = MyVal+_myVal;        //局部变量使用Camel命名法
    }

    public int AnotherMethod(int firstParameter) => firstParameter+_myVal;    //方法参数使用Camel命名法
}

在充分理解以上约定的基础上,清晰胜于简洁