《C#代码编写守则.docx》由会员分享，可在线阅读，更多相关《C#代码编写守则.docx（11页珍藏版）》请在三一文库上搜索。
1、C #代码编写规范目录简单功能准则错误！未指定书签。函数返回值原则错误！未指定书签。1 目的a) 为了统一公司软件开发设计过程的编程规范； b) 使开发人员能方便的理解每个目录、变量、控件、类、方法的意义； c) 为了保证编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范； d) 编码规范和约定必须能明显改善代码可读性，并有助于代码管理；2 适应范围本规范适用于企业所有基于.NET平台的软件开发人员，作用于软件项目开 发的代码编写阶段和后期维护阶段。3 术语及缩略语4 规范内容命名总体规则a) 名字应该能够标识事物的特性。b) 名字一律使用英文单词，而不能为拼音。c) 名字尽
2、量不使用缩写，除非它是众所周知的。d) 名字可以有两个或三个单词组成，但不应多于三个，控制在 3 至 30 个 字母以内。e) 在名字中， 多个单词用大写第一个字母 (其它字母小写) 来分隔。 例如： IsSuperUser 。f) 名字尽量使用前缀而不是后缀。g) 名字中的单词尽量使用名词，如有动词，也尽量放在后面。例如：FunctionUserDelete (而不是 FunctionDeleteUser )。命名规范1.2.1 变量命名1、程序文件(*.cs) 中的变量命名程序中变量名称=变量的前缀+代表变量含意的英文单词或单词缩写。类模块级的变量请用“ m，蚀据类型缩写作为前缀(其中，m
3、为“module”缩写，数据类型缩写见附件中的数据类型缩写表)。publicclass Hello privatestring m_strName;private DataTable m_dtblTable;类的属性所对应的变量，采用属性名前加“m_” +类型缩写前缀的形式publicclass Hello privatestring m_strName;private DataTable m_dtblTable;publicstring Namegetreturn m_strName;过程级的变量使用类型缩写前缀void Say() string strSayWord;过程的参数使用“ p_
4、” +类型缩写作为前缀(其中，p为“parameter”缩写)void Say(string pStrSayWord) string strSayWord;补充说明：针对异常捕获过程中的Exception变量命名，在没有冲突的情况下，统一命 名为ex；如果有冲突的情况下，可以用“ ex” + 标志名称，如：exSql。try即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名称。仅对于短循环索引使用单字母变量名，如 i或j。在变量名 中使用互补对，如 min/max、 begin/end 和 open/close 。不要使用原义数字或原义字符串，如 For(i=1;i=7;i
5、+)。而是使用命名常 数，如 For(i=1;i=NUM_DAYS_IN_WEEK;i+以便于维护和理解。2、控件命名控件命名二控件缩写前缀+“_”+名称；如：DataGriddg_UserList或 dgUserlist1.2.2 常量命名常量名也应当有一定的意义，格式为 NOUNE NOUNVERBT量名均为大写， 字之间用下划线分隔。例：privateconstbool WEB_ENABLEPAGECACHE_DEFAULT=privateconstint WEB_PAGECACHEEXPIRESINSECONDS_DEFAULT=3600;privateconstbool WEB_EN
6、ABLESSL_DEFAULT=;注：变量名和常量名最多可以包含 255个字符，但是，超过25到30个字符 的名称比较笨拙。止匕外，要想取一个有实际意义的名称，清楚地表达变量或常量 的用途，25或30个字符应当足够了。1.2.3 类(Class)命名a)名字应该能够标识事物的特性。b)名字尽量不使用缩写，除非它是众所周知的。c) 名字可以有两个或三个单词组成，但通常不应多于三个。d) 在名字中，所有单词第一个字母大写。例如 IsSuperUser ，包含 ID 的， ID 可以全部大写，如CustomerID。e) 使用名词或名词短语命名类。f) 少用缩写。g) 不要使用下划线字符(_) 。例
7、： publicclassFileStreampublicclassButtonpublicclassString4.2.4 接口 (Interface) 命名和类命名规范相同，唯一区别是接口在名字前加上“ I ”前缀。例：interfaceIMap ；或 interfaceIMapDocument ：4.2.5 方法 (Method) 命名和类命名规范相同；4.2.6 命名空间(NameSpace)命名和类命名规范相同；4.2.7 属性 (Property) 命名和类命名规范相同；注释规范4.3.1 概述a) 注释要求英文及英文的标点符号。b) 注释中， 应标明对象的完整的名称及其用途， 但
8、应避免对代码过于详细的 描述。c) 每行注释的最大长度为 100 个字符。d) 将注释与注释分隔符用一个空格分开。e) 不允许给注释加外框。f) 编码的同时书写注释。g) 重要变量必须有注释。h)变量注释和变量在同一行，所有注释必须对齐，与变量分开至少四个“空 格”键。如： intm_iLevel,m_iCount;.treelevel.countoftreeitemsstringm_strSql; 4.3.24.3.34.3.44.3.54.3.64.4.14.4.24.4.34.4.44.4.54.4.6 .4.4.7 Case 规则defaultcase 总应该存在，如果不允许到达，则应
9、该保证：若到达了就会触发一个错误。Case 的选择条件最好使用int 或 string 类型。4.4.81 f Else 规则如果你有用到 elseif 语句的话，通常最好有一个else 块以用于处理未处理到的其他情况。可以的话放一个记录信息注释在else 处，即使在 else 没有任何的动作。其格式为：if（条件1） 4.4.94.5.14.5.24.5.34.5.44.5.54.5.64.6.14.6.24.7.14.7.2ET 控件web 控件名缩写AdRotatorartButtonbtnCalendarcdCheckBoxchkCheckBoxListchklCompareValid
10、atorcpvCustomValidatorctvDataGriddgDataListdlDropDownListddlHyperLinkhlImageimgImageButtonIbtnLabellabLinkButtonlbtnListBoxlstPanelplPlaceHolderphRadioButtonrbRadioButtonListrblRangeValidatorrvRegularExpressionValidatorrevRepeaterrpRequiredFieldValidatorrfvTabletbTableCelltcTableRowtrTextBoxtxtValid
11、ationSummaryvsXMLXMLb、 html 控件html 控件名缩写HtmlAnchorhahHtmlButtonhbtnHtmlFormhformHtmlGenericControlhgcHtmlImagehimgHtmlInputButton （按钮）htxtHtmlInputButton （重置）hrbtnHtmlInputButton （提交）hcbtnHtmlInputCheckBoxhickHtmlInputFilehifileHtmlInputHiddenhihiddenHtmlInputImagehiimgHtmlInputRadioButtonhirbHtmlIn
12、putText （密码）hpwdHtmlInputText （文本）hitxtHtmlSelecthsltHtmlTablehtabHtmlTableCellhtcHtmlTableRowhtrHtmlTextAreahtxtac、控件类型前缀示例ConnectionconconNorthwindCommandcmdcmdReturnProductsParameterparmparmProductIDDataAdapterdaddadProductsDataReaderdtrdtrProductsDataSetdstdstNorthWindDataTabledtbldtblProductDataRowdrowdrowRow98DataColumndcoldcolProductIDDataRelationdreldrelMasterDetailDataViewdvwdvwFilteredProducts