将读盟科技编程规范.docVIP

编程规范 代码编写 对象的认识 = 模糊认识 + 清楚认识。当前类解决的是清楚认识部分，模糊认识由将来派生类完成。 方法的输入、输出要有严格的定义。要做到功能明确，不越权。 除非在万不得以的情况下，在类中不能定义公用字段，字段的引用尽量要采用属性形式。 不可修改的字段应用Const来修饰，并说明类型。 对你所写的每一个文件都加上相关的标准化注释，一般应包括：文件的作用、作者及时间等为你定义的类写详细的注释，包括作者、时间、信息、基本的算法等。/// summary /// class 的摘要说明。 /// /summary 为你定义的每一个写详细的注释，包括输入输出参数说明、返回值说明、功能说明/// summary /// 该方法的摘要信息 /// /summary /// param name=sqlsql参数的说明/param /// returns返回值的说明/returns public int ModifyData(string sql) { } 写注释的时候语义要明确，注释的长度最好不要超过一句话 所有（类、、）均要求意义明确易于理解避免在代码中直接使用数字等不确定意义的词，尽量使用有意义的串值代替不要写太长的if（）{...},for(){...},While(...){}或者太多的嵌套对上述较长者在范围结束处加注释。如//for 循环结束PageData data = CheckPage(pageID) 语句，其中pageID为当前操作页面的id，具体值见PageID类 命名指南 总的来说除了参数（包括方法内部定义的临时变量）和private作用域的字段采用Camel大小写的命名规则之外，其他的都采用Pascal大小写命名规则；如果字段是一个控件的实例，必须在后面跟上控件名；不要在字段前加g_ 或 s_private const string FILE_NAME = reg.aspx; 字段：private string fileName; 字段：public string FileName; 控件：protected System.Web.UI.WebControls.TextBox FileNameTextBox; 参数：string fileName; 有关具体的命名详细见以下各部分 大写样式 使用下面的三种大写标识符约定Pascal 大小写将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用 Pascal 大小写。例如： BackColorCamel 大小写标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如： backColor 大写标识符中的所有字母都大写。仅对于由两个或者更少字母组成的标识符使用该约定。例如： System.IO System.Web.UI可能还必须大写标识符以维持与现有非托管符号方案的兼容性，在该方案中所有大写字母经常用于枚举和常数值。一般情况下，在使用它们的程序集之外这些字符应当是不可见的。下表汇总了大写规则，并提供了不同类型的标识符的示例。标识符 大小写 示例 类 Pascal AppDomain 枚举类型 Pascal ErrorLevel 枚举值 Pascal FatalError 事件 Pascal ValueChange 异常类 Pascal WebException 注意???总是以 Exception 后缀结尾。 只读的静态字段 Pascal RedValue 接口 Pascal IDisposable 注意???总是以 I 前缀开始。 方法 Pascal ToString 命名空间 Pascal System.Drawing 参数 Camel typeName 属性 Pascal BackColor 受保护的实例字段 Camel redValue 注意???很少使用。属性优于使用受保护的实例字段。 公共实例字段 Pascal RedValue 注意???很少使用。属性优于使用公共实例字段。 为了避免混淆和保证跨语言交互操作，请遵循有关区分大小写的使用的下列规则：不要使用要求区分大小写的名称。对于区分大小写和不区分大小写的语言，组件都必须完全可以使用。不区分大小写的语言无法区分同一上下文中仅大小写不同的两个名称。因此，在创建的组件或类中必须避免这种情况。不要创建仅是名称大小写有区别的两个命名空间。例如，不区分大小写的语言无法区分以下两个命名空间声明。不要创建具有仅是大小写有区别的参数名称的函数。下面的示例是不正确的void MyFunction(string a, string A) 不要创建具有仅是大小写有区别的类型名称的命名空间。在下面的示例中，Point p 和 POI