项目编码规范.docx

项目编码规范 项目编码规范 项目编码规范 项目开发规则 C#命名规范 命名空间 框架中全部命名空间的开端部分 业务中全部命名空间的开端部分实质构造和名称以业务为准 类 名字应当能够表记事物的特征。 名字能够有两个或三个单词构成，但往常不该多于三个。 采纳 Pascal case ，全部单词第一个字母大写。 使用名词或名词短语命名类。 少用缩写。 不要使用下划线字符 (_) 。 例： public class FileStream public class Button 接口 和类命名规范同样，独一差别是接口在名字前加上“ I ”前缀 例： interface IDBCommand interface IButton 列举 和类命名规范同样，独一差别是列举在名字前加上“ E”前缀 例： enum ESystemType 方法 1) 2) 3) 1) 2) 3)  使用动词或动词短语命名方法。 采纳 Pascal case ，全部单词第一个字母大写。 方法中的参数命名采纳 Camel casing, 全部单词第一个字母大写，除了首字母小写。 属性 使用名词或名词短语命名 采纳 Pascal case ，全部单词第一个字母大写 少用缩写 不要使用下划线字符 ( _ ) 变量 变量名称 = 变量的前缀 + 代表变量含意的英文单词或单词缩写。常用变量种类的前缀命名规则，定义以下： 种类前缀 bool bln byte byt char char double dbl float flt integer int long lng object obj string str 常用对象 : 种类 前缀 Collection coll DateTime dt DataSet ds DataReader drd DataRow dr DataColumn dc Hashtable hs XmlDom xml XmlReader xr 2) 类的私有变量，在按照第一条规则后，在其前加“ m_”前缀。 例 : public class Hello { private string m_strName; public string Name { get { return m_strName; } } } 3) 即便关于可能仅出此刻几个代码行中的生计期很短的变量， 仍旧使用存心义 的名称。仅关于短循环索引使用单字母变量名，如 i 或 j 。 4) 不要使用原义数字或原义字符串，如 for ( int i = 1;i = 7;i++) 。而是使 用命名常数，如 for ( int i = 1;i = NUM_DAYS_IN_WEEK;i++) 以便于保护和理 解。 常量 1) 常量的名字应当都大写，而且指出完好含义，单词之间用下划线（ _）分开。 例： const int PAGE_COUNT = 10; 控件 前台系统开发时， 只好使用下边列出的控件， 又不可以知足要求请先和模块负责 人联系。议论通事后才可使用，规范改正前禁止使用未列出的控件。 Framework 有供给相应控件的，不得使用 .Net 标准控件 控件命名 = Window控件缩写前缀 + 变量名 控件种类 命名 Button Btn CheckBox Chk ComboBox Cmb DateTimeBox Dtb GroupBox Grb Label Lbl LookupBox Lkp NumericBox Num Panel Pnl ProgressBar Pgb RadioButton Rad TextBox Txt MemoEdit Memo TreeView Tvw DataGrid Grid DataList List Image Img DropDownList Drp QUERY为前缀 元素的全部字母大写，各字母以下划线“_”切割 专用名词建议使用习惯缩写  1.10 数据集命名 规范 一般 数据 集命 名以 Ds 开 头 作为 查问 参数 的数 据集 命名 以 DsQue ry 开 头，表 名以 与后台交互的数据集不同意使用属性 1.11 说明 说明规范包含：类说明规范、类的属性、方法说明规范、代码间说明规范 类说明规范 类开始一定以以下形式书写类说明： 项目文件 (*.csproj) 签出后应当尽早签入，以防止影响其余人使用。 签入前一定先编译经过，编译通事后的文件同意签入 3． 有关文件一定一次性签入，介绍整个项目一次性整体签入 4． 每天下班前，一定签入编译经过的版本。 总则：不论你用什么命名方法，全部的命名规则必定要一致，不要一会儿中文拼音 一会儿英文等等。 1、采纳英文单词或英文短语（包含缩写）作为名称，不可以使用无心义的字