程序编码规范.docVIP

卷号 卷内编号 密级  程序编码规范 项目名称： 项目编号： 编写人员： 编写日期： 审批人员： 审批日期： 1. 命名规范 1 1.1 namespace的命名 1 1.2 Class的命名 1 1.3 局部变量的命名 1 1.4 Static 变量的命名 1 1.5 参数的命名 1 1.6 数组的命名 1 1.7 方法的参数 2 2. C#文件样式 2 2.1 版权信息 2 2.2 Package/Imports 2 2.3 类的注释 2 2.4 类 3 2.4.1成员变量 3 2.4.2 构造函数 3 2.4.3 类方法 3 2.4.4 ToString 方法 4 2.4.5 main 方法 4 3. 代码编写格式 4 3.1 缩进 4 3.2 页宽 4 3.3 换行 4 3.4 {} 对 5 3.5 括号 5 3.6 每行申明变量的数量 5 3.7初始化 5 3.8布局 6 3.9简单语句 6 3.10 返回语句 6 3.11 if-else语句 6 3.12 空格 7 4. 程序编写规范 7 4.1 异常 7 4.2 final 类 7 5. 编程技巧 8 6. 性能 8 1. 命名规范 定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。（这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性） 1.1 namespace的命名 namespace的名字应该都是由一个大写字母开头的单词组成，若由多个单词组成，每个单词的首字母大写。 1.2 Class的命名 Class 的名字必须由大写字母开头而其他字母都小写的单词组成， 例如： class Raster; 1.3 局部变量的命名 变量的名字必须用一个小写字母开头。后面的单词用大写字母开头。 1.4 Static 变量的命名 Static 变量的名字应该都大写，并且指出完整含义。 1.5 参数的命名 参数的名字必须和变量的命名规范一致。 1.6 数组的命名 数组应该总是用下面的方式来命名： byte[] buffer; 而不是： byte buffer[]; 1.7 方法的参数 使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字： SetCounter(int size) { this.size = size; } 2. C#文件样式 所有的 C# 文件都必须遵守如下的样式规则 2.1 版权信息 版权信息必须在 C#文件的开头，比如： /** * Copyright ?2000 Shanghai XXX Co. Ltd. * All right reserved. */ 其他不需要出现在 javadoc 的信息也可以包含在这里。 2.2 Package/Imports package 行要在 import 行之前，import 中标准的包名要在本地的包名之前，而且按照字母顺序排列。如果 import 行中包含了同一个包中的不同子目录，则应该用 * 来处理。 using System; using System.Data; using System.Data.SqlCommand; 2.3 类的注释 接下来的是类的注释，一般是用来解释类的。 /** * A class representing a set of packet and byte counters * It is observable to allow it to be watched, but only * reports changes when the current set is complete */ 2.4 类 public class CounterSet:Observable,Cloneable 2.4.1成员变量 成员变量应该尽量定义成私有，通过属性来访问。 2.4.2 构造函数 接下来是构造函数，它应该用递增的方式写（比如：参数多的写在后面）。访问类型 (public, private 等.) 和 任何 static应该在一行中，这样可以使方法和参数更易读。 public CounterSet(int size) { this.size = size; } 2.4.3 类方法 下面开始写类的方法： /** * Set the packet counters * (such a