附录1 C#程序编码规范.docVIP

最全面的C#程序编码规范 目的 为了保证所每个项目组编写出的程序都符合相同的规范，便于提高代码的可读性和可维护性，便于检查、减少出错概率，有助于项目组成员间交流，保证一致性、统一性而建立的C#程序编码规范。 范围 该规范适用于所有基于C#开发的.Net平台项目，为详细设计，代码编写和代码审核提供参考和依据。如超过则应换行，换行后的代码应该缩进一个Tab。注释增加代码的清晰度保持注释的简洁，不是任何代码都需要注释的，过多的注释反而会影响代码的可读性。注释不要包括其他的特殊字符建议先写注释，后写代码，注释和代码一起完成 如果语句块（比如循环和条件分枝的代码块）代码太长，嵌套太多，则在其结束“｝”要加上注释，标志对应的开始语句。如果分支条件逻辑比较复杂，也要加上注释。 /********************************************* * 文 件 名: * 功能描述： * Copyright (c) 2010-2012 *********公司技术开发部 * 创 建 人: * 日 期: * 修 改 人: * 修改日期: * 修改描述: * 版 本: * *******************************************/ 注：这里的修改人，是指对整个类进行修改过，需要在这些添加修改记录，且记录累加。 当模块有重大修改或修改他人代码时，必须添加以下注释： /***************************************************** * 修 改 人: * 日 期: * 修改描述：对此修改的描述 * 版 本: * 修 改 人: * 日 期: * 修改描述：对此修改的描述 * 版 本: ***************************************************/ 修改时根据需要保留程序员第一次和最近一次修改的代码。具体办法是将原有代码注释。(保留第一次的代码可以反映此部分代码最初要实现的功能及其初始编程思想，保留最新的代码可以反映此代码最近变化要实现的最新功能) 2.2、类属性注释规范 在类的属性必须以以下格式编写属性注释： /// summary ///属性说明 /// /summary 2.3、方法注释规范 在类的方法声明前必须以以下格式编写注释： /// /summary ///函数的作用 /// param name=参数名称参数说明/param /// returns对方法返回值的说明，该说明必须明确说明返回的值代表什么含义 /returns ///exception异常类型、异常结果说明（为什么产生此异常）/exception 在Visual Studio环境中，在方法中上一行中输入///，开发环境会自动生成注释模板。 例如： #region UpgradeThread /// summary /// 构造函数 /// /summary /// param name= str1’ 示例参数1/param /// param name= str2示例参数2/param public UpgradeThread(string str1, string str2) { } #endregion 2.4、代码间注释规范 代码间注释分为单行注释和多行注释。 单行注释： //单行注释（不提倡使用，尽量都使用/**/） 多行注释： /*多行注释1 *多行注释2 *多行注释3*/ 代码中遇到语句块（if，case……）或实现一个逻辑功能时，必须添加注释。添加的注释应该能够说明此语句块的作用和实现手段（所用算法等等）。 3、命名规范 3.1、类变量命名:类变量命名一律用下划线开头，多个单词组成，第一个字母小写的，其他单词第一个字母大写类命名: 3.2.1、名字应该能够标识事物的特性； 3.2.2、首字母大写，缩略语可以全部字母大写； 3.2.3、名字可以有两个或三个单词组成，但通常不应多于三个； 3.2.4、在名字中，每个单词的第一个字母大写。例如：IsSuperUser；包含ID的，ID全部大写，如CustomerID； 3.2.5、使用名词或名词短语命名类； 3.2.6、少用缩写，除非是被广泛使用的； 3.2.7、不要使用下划线字符 (_)。 3.3、局部变量命名：由小写字母开头，其他单词开头字母大写的各单词组成。nt localVar; 3.4、函数命名：一律由大写字母开头的各个单词组成public void GetValue(int type) { //… } 3.5、枚举类型命