ASP.net/C#编码规范

最新推荐文章于 2020-01-05 21:32:40 发布

原创最新推荐文章于 2020-01-05 21:32:40 发布 · 2k 阅读

CC 4.0 BY-SA版权

文章标签：

41 篇文章

订阅专栏

本文档详细介绍了 ASP.NET/C# 开发中的编码规范，包括命名规范、注释规范、代码可读性及格式等方面的要求。通过遵循这些规范，可以提升代码质量并促进团队协作。

1、 ASP.net/C# 编码规范

以下对本节使用的名词进行说明。

Pascal

所有单词第一个字母大写，其他字母小写。

例如： public void GetUserNameByGuid()

Camel

除了第一个单词，所有单词第一个字母大写，其他字母小写。

例如： string userName

Hungarian

对象类型（小写）＋功能名称（大写，可以无此段）＋操作对象（大写）。

例如： <asp:Label ID=”lblUserName” />

命名规范的具体要求详见表。

项	编码形式	相关例子	注释
文件	Pascal	DatabaseConnector	使用名词来描述类
类	Pascal	DatabaseConnector	类的名称应该与定义它们的文件的名称匹配
接口	Pascal	IDatabaseConnector	接口名称以一个字母 I 开头
方法	Pascal	CalculateBalance	使用动词来描述方法
私有和受保护的实例字段	camel	private float accountBalance
公共实例字段	Pascal	CustomerName
私有和受保护的类字段	camel	protected static int numberOfAccounts
公共类字段	Pascal	public static bool HasGoodCredit
static final	全部大写	public static final decimal MINNUMBALANCE = 100
局部变量	camel	string accountNumber = FindAccountByCustomerName(customerName)
循环计数	全部小写	int i =0; while(i <10) {i ++;}
参数	camel	GetCurrentBalance(string accountNumber )
属性	Pascal	public string AccountNumber {get {return accountNumber;}}
控件 id,name	Hungarian	<asp:TextBox ID=”tbInfoTitle ” Name=”tbInfoTitle ”></ asp:TextBox >	对象类型名缩写见控件匈牙利命名缩写表
命名空间	Pascal	namespace DataLayer
单元测试方法	Pascal	TestFindAllCustomers	单元测试名称以单词 Test 开头。
解决方案	Pascal	NorthWindTrader
项目	Pascal	DataLayer

控件匈牙利命名缩写表。

1 、函数、属性、类等注释

请使用 /// 三斜线注释，这种注释是基于 XML 的，不仅能导出 XML 制作帮助文档，而且在各个函数、属性、类等的使用中，编辑环境会自动带出注释，方便你的开发。以 protected ， protected Internal ， public 声明的定义注释请都以这样命名方法。

类型	相关例子	说明
文档注释	/// <summary> /// This class represents a bank account /// </summary>	用于文档类和方法
行末注释	int myCount = 0; // Keep track of how many times ...	用于描述某些含义不太清晰的事物的目的
单行注释	// Here is where we gather account data	用于描述后续事物或者代码块的目的
多行注释	/* Here is where we gather account data */	用于在代码块处进行注释，或者用于描述后续多行代码的目的