C#书写规范

C#书写规范攻略

1. 命名规范

1.1 类和接口命名

• 类名和接口名应该使用帕斯卡命名法（PascalCase），即每个单词的首字母大写，不使用下划线或连字符。
• 类名应该是名词或名词短语，描述类的职责和功能。
• 接口名应该以\"I\"开头，后面跟随描述接口职责和功能的名词或名词短语。

示例：

public class UserService
{
    // 类的实现
}

public interface ILoggingService
{
    // 接口的定义
}

1.2 方法和属性命名

• 方法和属性名应该使用帕斯卡命名法（PascalCase），即每个单词的首字母大写，不使用下划线或连字符。
• 方法名应该是动词或动词短语，描述方法的操作和功能。
• 属性名应该是名词或名词短语，描述属性的特征和含义。

示例：

public class UserService
{
    public void CreateUser(string username, string password)
    {
        // 方法的实现
    }

    public string UserName { get; set; }
}

2. 代码布局规范

2.1 缩进和空格

• 使用四个空格进行缩进，不使用制表符。
• 在二元运算符前后添加一个空格，使代码更易读。

示例：

public class Calculator
{
    public int Add(int a, int b)
    {
        int result = a + b;
        return result;
    }
}

2.2 大括号的使用

• 在类、方法和控制结构的声明后，使用新的一行开始大括号，并在新的一行结束大括号。
• 在方法体内，使用新的一行开始大括号，并在新的一行结束大括号。

示例：

public class Calculator
{
    public int Add(int a, int b)
    {
        if (a > 0 && b > 0)
        {
            return a + b;
        }
        else
        {
            return 0;
        }
    }
}

3. 注释规范

3.1 类和方法注释

• 在类和方法的声明前，使用三斜杠（///）添加注释，描述类和方法的功能、参数和返回值。

示例：

/// <summary>
/// 用户服务类，提供用户相关的操作和功能。
/// </summary>
public class UserService
{
    /// <summary>
    /// 创建用户。
    /// </summary>
    /// <param name=\"username\">用户名。</param>
    /// <param name=\"password\">密码。</param>
    public void CreateUser(string username, string password)
    {
        // 方法的实现
    }
}

3.2 行内注释

• 在代码行的末尾，使用双斜杠（//）添加注释，解释代码的用途和作用。

示例：

public class Calculator
{
    public int Add(int a, int b)
    {
        int result = a + b; // 计算两个数的和
        return result;
    }
}

以上是C#书写规范的一些基本要求和示例说明。遵循这些规范可以提高代码的可读性和可维护性，使团队成员更容易理解和使用你的代码。