C#代码通俗易懂标准

《C#代码通俗易懂标准》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、C#代码通俗易懂编码标准一、目的为了保证所每个项目组编写出的程序都符合相同的规范，便于提高代码的可读性和可维护性，便于检查、减少出错概率，有助于项目组成员间交流，保证一致性、统一性而建立的C#程序编码规范。二、范围该规范适用于所有基于C#开发的.Net平台项目，为详细设计，代码编写和代码审核提供参考和依据。三、规范内容1、代码格式1.1、要使所有的缩进为一个Tab，即4个空格，使用VS.NET的默认设置。1.2、在代码中垂直对齐左括号和右括号。if(x==0){Response.Write("用户编号必须输入！");}不允许以下情况：if

2、(x==0){Response.Write("用户编号必须输入！");}或者：if(x==0){Response.Write("用户编号必须输入！");}1.3、为了防止在阅读代码时滚动源代码编辑器，每行代码或注释在1024*768的分辨率下尽量不超过一显示屏，如超过则应换行，换行后的代码应该缩进一个Tab。1.4、当一行被分为几行时，将串联运算符放在每一行的末尾而不是开头，清楚地表示没有后面的行是不完整的。1.5、每一行上放置的语句避免超过一条，避免写inti=0;intj=1;1.6、在大多数运算符之前和之后使用空格，这样做时不会改变

3、代码的意图却可以使代码容易阅读。例：intj=i+k;而不应写为intj=i+k;1.7、将大的复杂代码节分为较小的、易于理解的模块。1.8、编写SQL语句时，建议（不强求）对于关键字使用全部大写，对于数据库元素（如表、列和视图）使用大小写混合。1.9、将每个主要的SQL子句放在不同的行上，这样更容易阅读和编辑语句，例如：SELECTFirstName,LastNameFROMCustomersWHEREState='WA'2、注释规范注释是为了增加代码的清晰度，保持注释的简洁，不是任何代码都需要注释的，过多的注释反而会影响代码的可读性。

4、注释不要包括其他的特殊字符，建议先写注释，后写代码，注释和代码一起完成。如果语句块（比如循环和条件分枝的代码块）代码太长，嵌套太多，则在其结束“｝”要加上注释，标志对应的开始语句。如果分支条件逻辑比较复杂，也要加上注释。注释规范主要包括：模块（类）注释规范、类属性注释规范、方法注释规范、代码间注释规范。2.1、模块（类）注释规范模块开始尽量以以下形式书写模块注释：/**********************************************文件名:*功能描述：*Copyright(c)2010-2012*********公

5、司技术开发部*创建人:*日期:*修改人:*修改日期:*修改描述:*版本:********************************************/注：这里的修改人，是指对整个类进行修改过，需要在这些添加修改记录，且记录累加。当模块有重大修改或修改他人代码时，必须添加以下注释：/******************************************************修改人:*日期:*修改描述：<对此修改的描述>*版本:*修改人:*日期:*修改描述：<对此修改的描述>*版本:****************

6、***********************************/修改时根据需要保留程序员第一次和最近一次修改的代码。具体办法是将原有代码注释。(保留第一次的代码可以反映此部分代码最初要实现的功能及其初始编程思想，保留最新的代码可以反映此代码最近变化要实现的最新功能)2.2、类属性注释规范在类的属性必须以以下格式编写属性注释：///