编写高质量c#代码的10个建议

Posted 2023-03-29 .NET100

1、使用有意义且见名知义的变量名

这个建议也是各个研发经理代码规范的要求之一，这个建议能让代码更清晰易读，因为有意义的变量名可以更好地表达代码的含义，让代码更易于维护和修改。同时，使用有意义的变量名也有助于节省时间，因为代码读者不再需要思考变量名的含义。在.NET推荐使用小驼峰命名法，实例代码如下:

//不推荐命名：
int x = 10; string a = "公众号：DotNET开发跳槽"; double p = 3.14;
//推荐使用命名：
int age = 10; string customerName = "公众号：DotNET开发跳槽"; double pi = 3.14;

2、使用using语句来释放内存

使用using语句主要来释放网络请求、文件IO读写、数据库链接、大内存方法等操作。建议能提高代码的性能和可靠性。当我们使用using语句来释放内存时，会自动释放由该对象使用的系统资源，从而减少内存泄露的可能性，提高代码性能和可靠性。

//不推荐
SqlConnection connection = new SqlConnection(connectionString); // 这个需要使用 connection.Close()关闭链接;
//推荐
using(SqlConnection connection = new SqlConnection(connectionString))  // 不需要操作关闭，自动释放内存 

3、避免魔术数字。将数字和其他重要的值设置为常量或枚举

魔术数字（Magic Number）指的是代码中出现的一些硬编码常量，它们通常没有明确的含义说明，也没有被封装成常量或枚举等更为清晰的形式。 这个建议能提高代码的可读性和可维护性。将魔术数字设置为常量或枚举可以让代码更易于阅读和理解，因为我们可以快速地识别特定变量的含义。此外，如果需要更改数字或其他重要值，只需要更改常量或枚举的定义即可。

//不推荐
int colorCode = 0xFF0000;
//推荐使用
const int COLOR_RED = 0xFF0000; 
//在实际中运用
int colorCode = COLOR_RED;

4、使用LINQ来简化集合操作

LINQ提供了一种简洁、强大的语法，可以帮助我们更方便、高效地操作集合数据。案例如下：

//不推荐
List<int> list = new List<int> 1, 2, 3, 4, 5; List<int> evenNumbers = new List<int>(); foreach (int number in list)  if (number % 2 == 0)  evenNumbers.Add(number);  
//推荐
List<int> list = new List<int> 1, 2, 3, 4, 5; List<int> evenNumbers = list.Where(n => n % 2 == 0).ToList();

5、使用并行编程来提高性能

使用并行编程可以帮助我们更有效地利用多核处理器，并提高代码的性能，尤其是处理大量的数据。当然如果数据量比较小不推荐使用。如下：

//不推荐
for (int i = 0; i < 10000000; i++)  //执行的任务 
//推荐
Parallel.For(0, 10000000, i =>  //执行的任务 );

6、使用字符串插值或格式化字符串来避免冗长的字符串连接

使用字符串插值或格式化字符串可以使代码更容易阅读和维护，并避免冗长的字符串连接。示例如下：

//不推荐
string name = "张山"; int age = 30; 
string message = "我的名字是 " + name + " ，我 " + age + "岁了。";
//推荐
string name = "张山"; int age = 30; 
string message = $"我的名字是 name ，我 age岁了。"; 
// 或者 string message = string.Format("我的名字是 0 ，我 1 岁了.", name, age);

7、使用NULL约束

使用NULL约束可以帮助我们更有效地处理空引用错误，从而提高代码的健壮性和可靠性。示例如下：

//不推荐
public string GetName()  return this.Name; 
//推荐
public string GetName()  return this.Name ?? "Unknown"; 

8、减少重复代码

尽量避免在代码中出现冗余、相似的部分，使用重用程序代码的技术，如继承、多态和接口。

//不推荐
public int SumArray(int[] arr)

    int sum = 0;
    foreach (int num in arr)
    
        sum += num;
    
    return sum;

public int AverageArray(int[] arr)

    int sum = 0;
    foreach (int num in arr)
    
        sum += num;
    
    return sum / arr.Length;

// 推荐这样。另外有必要加上注释
public int SumArray(int[] arr)

    return arr.Sum();

public int AverageArray(int[] arr)

    return (int)arr.Average();

9、限制方法的参数数量

如果你的方法参数过多的话，建议新建一个对象来存储这些参数，案例如下：

//不推荐
public void Example(int a, int b, int c, int d, int e, int f)

    // 执行的内容

//推荐  SomeObject 是新建的对象
public void Example(SomeObject obj)

    // 执行的内容

10、避免使用不必要的装箱和拆箱，使用泛型方法来代替。

频繁的装箱和拆箱会对系统的性能有所影响，建议使用泛型来代替。在使用泛型时，编译器会生成针对特定类型的代码，这就可以避免将数据类型从值类型装箱成对象类型，再在需要时将其拆箱。这是因为泛型方法和泛型类可以推断出类型参数所需的正确类型，因此它们不需要装箱和拆箱操作。案例如下：

//不推荐
public void ExampleMethod(object someObject)

    int someInt = (int) someObject;

//推荐
public void ExampleMethod<T>(T someObject)

    int someInt = Convert.ToInt32(someObject);

结语

本文讲述了编写高质量c#代码的10个建议，代码仅供参考，实际开发过程中根据项目情况灵活应用。你有好的建议也可以留言。希望本文对你有所收获，同时小编欢迎你留言和吐槽。

来源公众号：DotNet开发跳槽