Loading... # C#编码规范 ## 命名规范 ### 帕斯卡命名 > 使用场景 </br> > 命名 ```class```、```record``` 或 ```struct``` 时,使用 pascal 大小写(“PascalCasing”) 例如: ```csharp public class DataService { } ``` ```csharp public record PhysicalAddress( string Street, string City, string StateOrProvince, string ZipCode); ``` ```csharp public struct ValueCoordinate { } ``` > 其中命名 ```interface``` 时,使用 pascal 大小写并在名称前面加上前缀 I。 这可以清楚地向使用者表明这是 interface 例如: ```csharp public interface IWorkerQueue { } ``` > 命名类型的 ```public``` 成员(例如字段、属性、事件、方法和本地函数)时,请使用 pascal 大小写 例如: ```csharp public class ExampleEvents { // A public field, these should be used sparingly public bool IsValid; // An init-only property public IWorkerQueue WorkerQueue { get; init; } // An event public event Action EventProcessing; // Method public void StartEventProcessing() { // Local function static int CountQueueItems() => WorkerQueue.Count; // ... } } ``` > 编写位置记录时,对参数使用 pascal 大小写,因为它们是记录的公共属性 例如: ```csharp public record PhysicalAddress( string Street, string City, string StateOrProvince, string ZipCode); ``` ### 驼峰命名法 > 使用场景 </br> > 命名 ```private``` 或 ```internal``` 字段时,使用驼峰式大小写(“camelCasing”),并且它们以 _ 作为前缀 例如: ```csharp public class DataService { private IWorkerQueue _workerQueue; } ``` > 使用为 ```private``` 或 ```internal``` 的```static``` 字段时 请使用 ```s_``` 前缀,对于线程静态,请使用 ```t_``` 例如: ```csharp public class DataService { private static IWorkerQueue s_workerQueue; [ThreadStatic] private static TimeSpan t_timeSpan; } ``` > 编写```方法参数```时,请使用驼峰式大小写 例如: ```csharp public T SomeMethod<T>(int someNumber, bool isValid) { } ``` ### 其他命名约定 > 使用场景 </br> 在不包括 ```using``` 指令的示例中,使用命名空间限定。 如果你知道命名空间默认导入项目中,则不必完全限定来自该命名空间的名称。 如果对于单行来说过长,则可以在点 (.) 后中断限定名称,如下面的示例所示 例如: ```csharp var currentPerformanceCounterCategory = new System.Diagnostics. PerformanceCounterCategory(); ``` ## 布局约定 - 使用默认的代码编辑器设置(智能缩进、4 字符缩进、制表符保存为空格) - 每行只写一条语句 - 每行只写一个声明 - 如果连续行未自动缩进,请将它们缩进一个制表符位(四个空格) - 在方法定义与属性定义之间添加至少一个空白行 - 使用括号突出表达式中的子句,如下面的代码所示 ```csharp if ((val1 > val2) && (val1 > val3)) { // Take appropriate action. } ``` ### 将 ```using``` 指令放在命名空间声明之外 > 当 ```using``` 指令位于命名空间声明之外时,该导入的命名空间是其完全限定的名称。 这样就比较清楚了。 如果 ```using``` 指令位于命名空间内部,它可以是相对于该命名空间的,也可以是完全限定的名称。 这容易说不清楚。 例如: ```csharp using Azure; namespace CoolStuff.AwesomeFeature { public class Awesome { public void Stuff() { WaitUntil wait = WaitUntil.Completed; … } } } ``` 禁止: ```csharp namespace CoolStuff.AwesomeFeature { using Azure; public class Awesome { public void Stuff() { WaitUntil wait = WaitUntil.Completed; … } } } ``` ### 使用全局usings指令 > .NET 6发布后支持C#10,C# 10 全局的usings使用:<br/> using 指令简化了使用命名空间的方式, C# 10 包括一个新的全局 usings 指令 usings,以减少需要在每个文件顶部指定的 usings 数量 创建全局usings文件 ```GlobalUsings.cs``` 在该类下添加本类库所有的引用 例如: ```csharp global using System; global using System.Collections.Generic; global using System.ComponentModel.DataAnnotations; global using System.Globalization; global using System.IO; global using System.Linq; global using System.Text; ``` ## 注释约定 - 将注释放在单独的行上,而非代码行的末尾 - 以大写字母开始注释文本 - 以句点结束注释文本 - 在注释分隔符 (//) 与注释文本之间插入一个空格,如下面的示例所示 ```csharp // The following declaration creates a query. It does not run // the query. ``` - 请勿在注释周围创建格式化的星号块 - 请确保所有公共成员都有必要的 XML 注释,从而提供有关其行为的适当说明 ## 语言准则 ### 字符串数据类型 - 使用字符串内插来连接短字符串,如下面的代码所示 ```csharp string displayName = $"{nameList[n].LastName}, {nameList[n].FirstName}"; ``` - 若要在循环中追加字符串,尤其是在使用大量文本时,请使用 ```StringBuilder``` 对象 ```csharp var phrase = "lalalalalalalalalalalalalalalalalalalalalalalalalalalalalala"; var manyPhrases = new StringBuilder(); for (var i = 0; i < 10000; i++) { manyPhrases.Append(phrase); } //Console.WriteLine("tra" + manyPhrases); ``` ### 隐式类型本地变量 - 当变量类型明显来自赋值的右侧时,或者当精度类型不重要时,请对本地变量进行隐式类型化 ```csharp var var1 = "This is clearly a string."; var var2 = 27; ``` - 当类型并非明显来自赋值的右侧时,请勿使用 var。 请勿假设类型明显来自方法名称。 如果变量类型为 new 运算符或显式强制转换,则将其视为明显来自方法名称 ```csharp int var3 = Convert.ToInt32(Console.ReadLine()); int var4 = ExampleClass.ResultSoFar(); ``` - 请勿依靠变量名称来指定变量的类型。 它可能不正确。 在以下示例中,变量名称 inputInt 会产生误导性。 它是字符串 ```csharp var inputInt = Console.ReadLine(); Console.WriteLine(inputInt); ``` - 避免使用 var 来代替 dynamic。 如果想要进行运行时类型推理,请使用 dynamic - 使用隐式类型化来确定 for 循环中循环变量的类型 </br></br>下面的示例在 for 语句中使用隐式类型化 ```csharp var phrase = "lalalalalalalalalalalalalalalalalalalalalalalalalalalalalala"; var manyPhrases = new StringBuilder(); for (var i = 0; i < 10000; i++) { manyPhrases.Append(phrase); } //Console.WriteLine("tra" + manyPhrases); ``` - 不要使用隐式类型化来确定 foreach 循环中循环变量的类型。 在大多数情况下,集合中的元素类型并不明显。 不应仅依靠集合的名称来推断其元素的类型。 </br></br>下面的示例在 foreach 语句中使用显式类型化 ```csharp foreach (char ch in laugh) { if (ch == 'h') Console.Write("H"); else Console.Write(ch); } Console.WriteLine(); ``` ### 无符号数据类型 > 通常,使用 ```int``` 而非无符号类型。 ```int``` 的使用在整个 C# 中都很常见,并且当你使用 ```int``` 时,更易于与其他库交互 ### 数组 - 当在声明行上初始化数组时,请使用简洁的语法。 在以下示例中,请注意不能使用 ```var``` 替代 ```string[]``` ```csharp string[] vowels1 = { "a", "e", "i", "o", "u" }; ``` - 如果使用显式实例化,则可以使用 ```var``` ```csharp var vowels2 = new string[] { "a", "e", "i", "o", "u" }; ``` ### 委托 - 使用 ```Func<>``` 和 ```Action<>```,而不是定义委托类型。 在类中,定义委托方法 ```csharp public static Action<string> ActionExample1 = x => Console.WriteLine($"x is: {x}"); public static Action<string, string> ActionExample2 = (x, y) => Console.WriteLine($"x is: {x}, y is {y}"); public static Func<string, int> FuncExample1 = x => Convert.ToInt32(x); public static Func<int, int, int> FuncExample2 = (x, y) => x + y; ``` - 使用 ```Func<>``` 或 ```Action<>``` 委托定义的签名来调用方法 ```csharp ActionExample1("string for x"); ActionExample2("string for x", "string for y"); Console.WriteLine($"The value is {FuncExample1("1")}"); Console.WriteLine($"The sum is {FuncExample2(1, 2)}"); ``` - 如果创建委托类型的实例,请使用简洁的语法。 在类中,定义委托类型和具有匹配签名的方法 ```csharp public delegate void Del(string message); public static void DelMethod(string str) { Console.WriteLine("DelMethod argument: {0}", str); } ``` 创建委托类型的实例,然后调用该实例。 以下声明显示了紧缩的语法 ```csharp Del exampleDel2 = DelMethod; exampleDel2("Hey"); ``` 以下声明使用了完整的语法 ```csharp Del exampleDel1 = new Del(DelMethod); exampleDel1("Hey"); ``` ### ```try-catch``` 和 ```using``` 语句正在异常处理中 - 对大多数异常处理使用 ```try-catch``` 语句 ```csharp static string GetValueFromArray(string[] array, int index) { try { return array[index]; } catch (System.IndexOutOfRangeException ex) { Console.WriteLine("Index is out of range: {0}", index); throw; } } ``` - 通过使用 C# using 语句简化你的代码。 如果具有 ```try-finally``` 语句(该语句中 ```finally``` 块的唯一代码是对 Dispose 方法的调用),请使用 ```using``` 语句代替。 在以下示例中,try-finally 语句仅在 finally 块中调用 Dispose ```csharp Font font1 = new Font("Arial", 10.0f); try { byte charset = font1.GdiCharSet; } finally { if (font1 != null) { ((IDisposable)font1).Dispose(); } } ``` 可以使用 ```using``` 语句执行相同的操作 ```csharp using (Font font2 = new Font("Arial", 10.0f)) { byte charset2 = font2.GdiCharSet; } ``` 使用不需要大括号的新 using 语法: ```csharp using Font font3 = new Font("Arial", 10.0f); byte charset3 = font3.GdiCharSet; ``` ### ```&&``` 和 ```||``` 运算符 若要通过跳过不必要的比较来避免异常并提高性能,请在执行比较时使用 &&(而不是 &)和 ||(而不是 |),如下面的示例所示 ```csharp Console.Write("Enter a dividend: "); int dividend = Convert.ToInt32(Console.ReadLine()); Console.Write("Enter a divisor: "); int divisor = Convert.ToInt32(Console.ReadLine()); if ((divisor != 0) && (dividend / divisor > 0)) { Console.WriteLine("Quotient: {0}", dividend / divisor); } else { Console.WriteLine("Attempted division by 0 ends up here."); } ``` 如果除数为 0,则 ```if``` 语句中的第二个子句将导致运行时错误。 但是,当第一个表达式为 false 时,&& 运算符将发生短路。 也就是说,它并不评估第二个表达式。 如果 ```divisor``` 为 0,则 & 运算符将同时计算这两个表达式,这会导致运行时错误 ### ```new``` 运算符 - 使用对象实例化的简洁形式之一,如以下声明中所示。 第二个示例显示了从 C# 9 开始可用的语法 ```csharp var instance1 = new ExampleClass(); ``` ```csharp ExampleClass instance2 = new(); ``` 前面的声明等效于下面的声明 ```csharp ExampleClass instance2 = new ExampleClass(); ``` - 使用对象初始值设定项简化对象创建,如以下示例中所示 ```csharp var instance3 = new ExampleClass { Name = "Desktop", ID = 37414, Location = "Redmond", Age = 2.3 }; ``` 下面的示例设置了与前面的示例相同的属性,但未使用初始值设定项 ```csharp var instance4 = new ExampleClass(); instance4.Name = "Desktop"; instance4.ID = 37414; instance4.Location = "Redmond"; instance4.Age = 2.3; ``` ### 事件处理 如果你正在定义一个稍后不需要删除的事件处理程序,请使用 lambda 表达式 ```csharp public Form2() { this.Click += (s, e) => { MessageBox.Show( ((MouseEventArgs)e).Location.ToString()); }; } ``` Lambda 表达式缩短了以下传统定义 ```csharp public Form1() { this.Click += new EventHandler(Form1_Click); } void Form1_Click(object? sender, EventArgs e) { MessageBox.Show(((MouseEventArgs)e).Location.ToString()); } ``` ### 静态成员 使用类名调用 static 成员:ClassName.StaticMember。 这种做法通过明确静态访问使代码更易于阅读。 请勿使用派生类的名称来限定基类中定义的静态成员。 编译该代码时,代码可读性具有误导性,如果向派生类添加具有相同名称的静态成员,代码可能会被破坏 ### LINQ查询 - 对查询变量使用有意义的名称。 下面的示例为位于西雅图的客户使用 ```seattleCustomers``` ```csharp var seattleCustomers = from customer in customers where customer.City == "Seattle" select customer.Name; ``` - 使用别名确保匿名类型的属性名称都使用 ```Pascal``` 大小写格式正确大写 ```csharp var localDistributors = from customer in customers join distributor in distributors on customer.City equals distributor.City select new { Customer = customer, Distributor = distributor }; ``` - 如果结果中的属性名称模棱两可,请对属性重命名。 例如,如果你的查询返回客户名称和分销商 ID,而不是在结果中将它们保留为 ```Name``` 和 ```ID```,请对它们进行重命名以明确 ```Name``` 是客户的名称,```ID``` 是分销商的 ID ```csharp var localDistributors2 = from customer in customers join distributor in distributors on customer.City equals distributor.City select new { CustomerName = customer.Name, DistributorID = distributor.ID }; ``` - 在查询变量和范围变量的声明中使用隐式类型化 ```csharp var seattleCustomers = from customer in customers where customer.City == "Seattle" select customer.Name; ``` - 对齐 from 子句下的查询子句,如上面的示例所示 - 在其他查询子句前面使用 where 子句,确保后面的查询子句作用于经过缩减和筛选的一组数据 ```csharp var seattleCustomers2 = from customer in customers where customer.City == "Seattle" orderby customer.Name select customer; ``` - 使用多行 ```from``` 子句代替 join 子句来访问内部集合。 例如,```Student``` 对象的集合可能包含测验分数的集合。 当执行以下查询时,它返回高于 90 的分数,并返回得到该分数的学生的姓氏 ```csharp var scoreQuery = from student in students from score in student.Scores! where score > 90 select new { Last = student.LastName, score }; ``` 最后修改:2023 年 06 月 08 日 © 允许规范转载 打赏 赞赏作者 支付宝微信 赞 2 如果觉得我的文章对你有用,请随意赞赏