服务器端C#编程规范.docVIP

服务器端C#编码规范 编码语言：C# 编码平台：Microsoft Visual Stidio 2010 团队成员： 编码规范： （1）代码格式 在代码中凡事遇到{ }需要另起一行对其，以保证代码的可读性如下： if (x = 1) { Console.write(必须另起一行); } 编码每一行仅限一条代码 编码必须含有注释，而且所有注释均在该需要注释的代码的上一行，如下： if (x = 1) { //控制台显示输出必须另起一行 Console.write(必须另起一行); } 凡事遇到（大多数情况下）运算符，都要在该运算符前和后加一个空格，增加代码的可读性 String strConnection = str + Connection; （2）命名规范 注意：命名过程中杜绝出现仅有大,,,,写不同的字符串命名，如 int COLOR 和int color 同时存在 变量命名遵循驼峰规则 如 colorButton; 类命名开头必须大写，而且是多个字符串（字符串太长时可以有缩写）拼接而成，每个字符串开头大写 如： FileString 命名过程中如没有特殊情况，请不要使用除大,,,,写以外的任何字符 命名时尽量考虑到见名知意的效果 接口命名：所有接口命名时请以大写I开头后面部分与类命名相似，但尽量不要使用缩写，无论多长 （3）静态字段命名 所有静态常量必须大写，可以有缩写 （4）事件响应命名 对事件处理程序名称使用 EventHandler 后缀 用 EventArgs 后缀命名事件参数类。 指定两个名为 sender 和 e 的参数。sender 参数表示引发事件的对象。sender 参数始终是 object 类型的，即使在可以使用更为特定的类型时也如此。与事件相关联的状态封装在名为 e 的事件类的实例中。对 e 参数类型使用适当而特定的事件类。 例如： public delegate void MouseEventHandler(object sender, MouseEventArgs e); 注释规范（Comment） 注释规范包括： 1.模块（类）注释规范、 2.类的属性、 3.方法注释规范、 4.代码间注释 a. 模块（类）注释规范 模块开始必须以以下形式书写模块注释： ///summary ///模块编号：模块编号，可以引用系统设计中的模块编号 ///作用：对此类的描述，可以引用系统设计中的描述 ///作者：作者中文名 ///编写日期：模块创建日期，格式：YYYY-MM-DD ////summary 如果模块有修改，则每次修改必须添加以下注释： ///summary ///Log编号：Log编号,从1开始一次增加 ///修改描述：对此修改的描述 ///作者：修改者中文名 ///修改日期：模块修改日期，格式：YYYY-MM-DD ////summary ? b. 类属性注释规范 在类的属性必须以以下格式编写属性注释： /// summary ///属性说明 /// /summary c 方法注释规范 在类的方法声明前必须以以下格式编写注释 /// summary /// 说明：对该方法的说明 /// /summary /// param name=参数名称参数说明/param /// returns ///对方法返回值的说明，该说明必须明确说明返回的值代表什么含义 /// /returns ? d. 代码间注释规范 代码间注释分为单行注释和多行注释： 单行注释： //单行注释 多行注释： /*多行注释1 多行注释2 多行注释3*/ 代码中遇到语句块时必须添加注释（if,for,foreach,……）,添加的注释必须能够说明此语句块的作用和实现手段（所用算法等等）。 （虽然比较繁琐，但磨刀不误砍柴工，这些都是很有必要的） 加油，加油。↖(^ω^)↗