C# 中的变量命名规范和注释如何写规范

C# 中的变量命名规范和注释如何写规范

C# 中的变量命名规范

以下是一些 C# 中常用的变量命名规范：
通用规则

• 所有命名都应使用以下两种方式之一：
  • Pascal 大写：每个单词的首字母都大写，例如：CustomerName, OrderDate
  • 骆驼式命名：第一个单词的首字母小写，之后每个单词的首字母大写，例如：customerName, orderDate
• 变量名应具有描述性，反映变量的用途或它存储的数据。例如，一个名为 customerCount 的变量比 count 更具描述性。
• 避免使用缩写或其他难以理解的命名。
• 变量名应区分大小写，这意味着 customerName 和 customername 是两个不同的变量。

具体规则

• 类名：使用 Pascal 大写命名法，例如：Customer, Order
• 方法名：使用 Pascal 大写命名法，并使用动宾结构，例如：GetCustomerById, CreateOrder
• 字段名：非公有字段建议使用下划线加骆驼式命名法，例如：_customerName, _orderDate。公有字段建议使用 Pascal 大写命名法，例如：CustomerName, OrderDate。
• 局部变量：使用骆驼式命名法，例如：customer, order
• 常量：使用 Pascal 大写命名法，并通常在名称末尾添加 _CONST 后缀，例如：CUSTOMER_NAME_MAX_LENGTH, ORDER_STATUS_PENDING

其他建议

• 对于具有多个单词的命名，可以使用连接符（-）来连接单词，例如：customer-name, order-date
• 避免使用特殊字符，例如：@, #, $

以下是一些违反命名规范的示例：

• i：这是一个非常通用的名称，没有提供有关变量用途的任何信息。
• customerID：虽然这个名称比 i 更具描述性，但它仍然可以使用 Pascal 大写命名法。
• _count：这个名称没有遵循下划线加骆驼式命名法的约定。
• getCustomer：这个方法名没有使用动宾结构。

C# 中的注释如何写规范 (适用于高版本VS，推荐vs2019及以上)

使用微软IDE中支持的 XML文档注释,可用于生成文档或者API。
在注释中，summary 代表简单总结，而remarks代表了具体的备注，更加详细。

在注释中显示数据类型关键字

加入see langword ，这样鼠标放上去的注释会被专门以类型显示

 /// for循环输出hello，输出n行，n是<see langword="int"/>类型数据

在注释中跳转到命名空间

加入see cref ,然后再鼠标放上去的注释中点击就可以跳转到对应的命名空间中

  /// 使用的命名空间是<see cref="System"/>