跳到主要内容

C# 代码风格

介绍​

在编写 C# 代码时，遵循一致的代码风格是非常重要的。良好的代码风格不仅能提高代码的可读性，还能使团队成员之间的协作更加顺畅。本文将介绍一些 C# 代码风格的最佳实践，帮助你编写出更清晰、更易维护的代码。

命名约定​

1. 类名和结构名​

类名和结构名应使用 PascalCase，即每个单词的首字母大写。例如：

csharp
public class CustomerOrder
{
    // 类成员
}

2. 方法名​

方法名也应使用 PascalCase。例如：

csharp
public void CalculateTotalPrice()
{
    // 方法实现
}

3. 变量名和参数名​

变量名和参数名应使用 camelCase，即第一个单词的首字母小写，后续单词的首字母大写。例如：

csharp
int totalPrice;
string customerName;

4. 常量名​

常量名应使用 UPPER_CASE，单词之间用下划线分隔。例如：

csharp
public const int MAX_ITEMS = 100;

代码格式化​

1. 缩进​

使用 4个空格 进行缩进，而不是制表符（Tab）。大多数现代 IDE 都可以自动处理这一点。

2. 大括号​

大括号 {} 应放在新的一行，并且与上一行的代码对齐。例如：

csharp
public void PrintMessage()
{
    Console.WriteLine("Hello, World!");
}

3. 行长度​

每行代码的长度应尽量控制在 80-120个字符 之间。如果一行代码过长，可以考虑将其拆分成多行。

注释​

1. 单行注释​

单行注释使用 //，并且注释内容应与代码保持一致的缩进。例如：

csharp
// 计算总价
int totalPrice = CalculateTotalPrice();

2. 多行注释​

多行注释使用 /* ... */，通常用于解释复杂的逻辑或算法。例如：

csharp
/*
 * 这是一个复杂的算法，
 * 用于计算订单的总价。
 */
int totalPrice = CalculateTotalPrice();

3. XML 文档注释​

对于公共 API，建议使用 XML 文档注释，以便生成 API 文档。例如：

csharp
/// <summary>
/// 计算订单的总价。
/// </summary>
/// <returns>订单的总价。</returns>
public int CalculateTotalPrice()
{
    // 方法实现
}

实际案例​

假设我们有一个简单的 Customer 类，用于存储客户信息。以下是一个符合 C# 代码风格的最佳实践的示例：

csharp
public class Customer
{
    private string firstName;
    private string lastName;
    private int age;

    public Customer(string firstName, string lastName, int age)
    {
        this.firstName = firstName;
        this.lastName = lastName;
        this.age = age;
    }

    public string GetFullName()
    {
        return $"{firstName} {lastName}";
    }

    public bool IsAdult()
    {
        return age >= 18;
    }
}

在这个示例中，我们遵循了命名约定、代码格式化和注释的最佳实践，使得代码清晰易读。

总结​

遵循一致的 C# 代码风格是编写高质量代码的关键。通过使用适当的命名约定、代码格式化和注释，你可以显著提高代码的可读性和可维护性。希望本文的内容能帮助你在编写 C# 代码时更加得心应手。

附加资源​

练习​

  1. 编写一个 Product 类，包含 Name、Price 和 Quantity 属性，并实现一个计算总价的方法。
  2. 为你的 Product 类添加 XML 文档注释，并生成 API 文档。
  3. 尝试将你的代码格式化，使其符合本文介绍的代码风格。

通过完成这些练习，你将更好地掌握 C# 代码风格的最佳实践。