C代码编写规范 .doc

《C代码编写规范 .doc》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、C#代码编写规范目录1目的a)为了统一公司软件开发设计过程的编程规范；b)使开发人员能方便的理解每个目录、变量、控件、类、方法的意义；c)为了保证编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范；d)编码规范和约定必须能明显改善代码可读性，并有助于代码管理；2适应范围本规范适用于企业所有基于.NET平台的软件开发人员，作用于软件项目开发的代码编写阶段和后期维护阶段。3术语及缩略语4规范内容命名总体规则a)名字应该能够标识事物的特性。b)名字一律使用英文单词，而不能为拼音。c)名字尽量不使用缩写，除非它是众所周知的。d)名字可以有两个或三个单词组成，但不应多于三个，控

2、制在3至30个字母以内。e)a)在名字中，多个单词用大写第一个字母（其它字母小写）来分隔。例如：IsSuperUser。b)名字尽量使用前缀而不是后缀。c)名字中的单词尽量使用名词，如有动词，也尽量放在后面。例如：FunctionUserDelete（而不是FunctionDeleteUser）。命名规范4.2.1变量命名1、程序文件(*.cs)中的变量命名程序中变量名称=变量的前缀+代表变量含意的英文单词或单词缩写。类模块级的变量请用“m_”+数据类型缩写作为前缀（其中，m为“module”缩写，数据类型缩写见附件中的《数据类型缩写表》）。publicclassHello{priva

3、testringm_strName;privateDataTablem_dtblTable;}类的属性所对应的变量，采用属性名前加“m_”+类型缩写前缀的形式publicclassHello{privatestringm_strName;privateDataTablem_dtblTable;publicstringName{get{returnm_strName;}}}过程级的变量使用类型缩写前缀voidSay(){stringstrSayWord;}过程的参数使用“p_”+类型缩写作为前缀（其中，p为“parameter”缩写）voidSay(stringpStrSayWord){

4、stringstrSayWord;}补充说明：针对异常捕获过程中的Exception变量命名，在没有冲突的情况下，统一命名为ex；如果有冲突的情况下，可以用“ex”+标志名称，如：exSql。try{即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名称。仅对于短循环索引使用单字母变量名，如i或j。在变量名中使用互补对，如min/max、begin/end和open/close。不要使用原义数字或原义字符串，如For(i=1;i<=7;i++)。而是使用命名常数，如For(i=1;i<=NUM_DAYS_IN_WEEK;i++)以便于维护和理解。2、控件命名控件命名=

5、控件缩写前缀+[“_”]+名称；如：DataGriddg_UserList或dgUserlist4.2.1常量命名常量名也应当有一定的意义，格式为NOUN或NOUN_VER。B常量名均为大写，字之间用下划线分隔。例：privateprivateconstconstboolintWEB_ENABLEPAGECACHE_DEFAUtrLuTe=;WEB_PAGECACHEEXPIRESINSECONDS_DEFAULT=3600;privateconstboolWEB_ENABLESSL_DEFAULfTal=se;注：变量名和常量名最多可以包含255个字符，但是，超过25到30个字符的名

6、称比较笨拙。此外，要想取一个有实际意义的名称，清楚地表达变量或常量的用途，25或30个字符应当足够了。4.2.2类(Class)命名a)名字应该能够标识事物的特性。b)名字尽量不使用缩写，除非它是众所周知的。c)名字可以有两个或三个单词组成，但通常不应多于三个。d)在名字中，所有单词第一个字母大写。例如IsSuperUser，包含ID的，ID可以全部大写，如CustomerID。e)a)使用名词或名词短语命名类。b)少用缩写。c)不要使用下划线字符(_)。例：publicclassFileStreampublicclassButtonpublicclassString4.2.1接口(I

7、nterface)命名和类命名规范相同，唯一区别是接口在名字前加上“I”前缀。例：interfaceIMap；或interfaceIMapDocument：4.2.2方法(Method)命名和类命名规范相同；4.2.3命名空间(NameSpace)命名和类命名规范相同；4.2.4属性(Property)命名和类命名规范相同；4.2.5注释规范4.3.1概述a)注释要求英文及英文的标点符号。b)注释中，应标明对象的完整的名称及其用途，但应避免对代