C代码编写规范方案.docx

上传人:p** 文档编号:321152 上传时间:2023-05-26 格式:DOCX 页数:24 大小:40.12KB
下载 相关 举报
C代码编写规范方案.docx_第1页
第1页 / 共24页
C代码编写规范方案.docx_第2页
第2页 / 共24页
C代码编写规范方案.docx_第3页
第3页 / 共24页
C代码编写规范方案.docx_第4页
第4页 / 共24页
C代码编写规范方案.docx_第5页
第5页 / 共24页
C代码编写规范方案.docx_第6页
第6页 / 共24页
C代码编写规范方案.docx_第7页
第7页 / 共24页
C代码编写规范方案.docx_第8页
第8页 / 共24页
C代码编写规范方案.docx_第9页
第9页 / 共24页
C代码编写规范方案.docx_第10页
第10页 / 共24页
亲,该文档总共24页,到这儿已超出免费预览范围,如果喜欢就下载吧!
资源描述

《C代码编写规范方案.docx》由会员分享,可在线阅读,更多相关《C代码编写规范方案.docx(24页珍藏版)》请在第壹文秘上搜索。

1、C#代码编写规X目录目录1目的21目的32适应X围33术语及缩略语44规X内容44.1 命名总体规则44.2 命名规X4421姬命名4422常量命名6423类(ClasS)命名6424口(Interfite)命名7425方法(Method)命名74.2.6命名空间(NameSPaCe)命名7427属性(Property)命名74.3 注释规X743.1 M743.2 2自建代码文件注释843.3 模块(类)注释9434类属性注释9435方法注释1043.4 6代码间注释104.4 编码规则IO4.4.1 错误检查规则104.4.2 括号规则U4.4.3 括号规则114.4.4 缩进规则114.

2、4.5 齐规则11446比较规则114.4.7 Cee规则12448IfElSe规则124.4.8 语句规则124.4.10 单一功能准则124.4.11 简单功能准则124.4.12 明确条件规则124.4.13 选用FalSe规则134.4.14 独立赋值规则134.4.15 定义常量规则134.4.16 模块化规则134.4.17 交流规则134.5 编程准则14451变量使用14452数据库操作141.1.1 象使刖41.1.4 模块设计原则14455结构化要求141.1.6 函数返回值原则154.6 代码包规X15461代码包的版本号15462代码包的标识164.7 代码控制174.

3、7.1 代码库/目录的建立174.7.2 代码归档17附件1:数据类型缩写表17附件2:控件名缩写表18a、.NET控件18b、html控件19c、ADO.NET控件201目的a)为了统一公司软件开辟设计过程的编程规X;b)使开辟人员能方便的理解每一个目录、变量、控件、类、方法的意义;c)为了保证编写出的程序都符合相同的规X,保证一致性、统一性而建立的程序编码规X;d)编码规X和约定必须能明显改善代码可读性,并有助于代码管理;2适应X本规X合用于企业所有基于.NET平台的软件开辟人员,作用于软件项目开发的代码编写阶段和后期维护阶段。3术语及缩略语4规X内容4.1命名总体规则a)名字应该能够标识

4、事物的特性。b)名字一律使用英文单词,而不能为拼音。c)名字尽量不使用缩写,除非它是众所周知的。d)名字可以有两个或者三个单词组成,但不应多于三个,控制在3至30个字母以内。e)在名字中,多个单词用大写第一个字母(其它字母小写)来分隔。例如:IsSuperUsero0名字尽量使用前缀而不是后缀。g)名字中的单词尽量使用名词,如有动词,也尽量放在后面。例如:FunctionUserDeIete(而不是FiinctionDeleteUser)o42命名规X421变量命名1、程叙文件(*.cs)中的变量命名程序中变量名称=变量的前缀+代表变量含意的英文单词或者单词缩写。类模块级的变量请用“m_”+数

5、据类型缩写作为前缀(其中,m为“module”缩写,数据类型缩写见附件中的数据类型缩写表)。PubliccIassHello(privatestringm_strName;PrivateDiitaTablem_dtblTable;)类的属性所对应的变量,采用属性名前加“mJ+类型缩写前缀的形式PublicclassHello(privatestringm_strName;PrivateEXiUiTablem-dtbable;publicstringName(妒returnm_strName;)过程级的变量使用类型缩写前缀voidSay()(StringstrSayWord;)过程的参数使用*_

6、”+类型缩写作为前缀(其中,p为“parameter”缩写)voidSay(StringpStrSayWord)(StringstrSayWord;)补充说明:针对异常捕获过程中的EXCePtiOn变量命名,在没有冲突的情况下,统一命名为ex;如果有冲突的情况下,可以用“ex”+标志名称,如:exSqL叮(代码Catch(Exceptionex)/代码)补充:如果捕获异常不需要作任何处理,则不需要定义EXCePtion实例。例:叮(代码)catch()鉴于大多数名称都是通过连接若干单词构造的,请使用大小写混合的格式以简化它们的阅读。每一个单词的第一个字母都是大写.即使对于可能仅浮现在几个代码行

7、中的生存期很短的变量,仍然使用故意义的名称。仅对于短循环索引使用单字母变量名,如i或者j。在变量名中使用互补对,如minmaxbegin/end和OPen/close。不要使用原义数字或者原义字符串,如For(i=l;i=7;i+)o而是使用命名常数,如For(i=l;i=NUM_DAYSJN_WEEK;i+)以便于维护和理解。2、控件命名控件命名二控件缩写前缀+“_”+名称;如:DataGridcRserList或者dgUserlist422常量常量名也应当有一定的意义,格式为NoUN或者Ne)UN_VERB。常量名均为大写,字之间用下划线分隔。例:privateconstboolWEB_E

8、NABLEPAGECACHE.DEFAULT=true;PrivateconstintWEB_PAGECACHEEXPIRESINSECONDS.DEFAULT=3600;PrivaieconsiboolWEB_ENABLESSL_DEFAULT=false;注:变量名和常量名最多可以包含255个字符,但是,超过25到30个字符的名称比较笨拙。此外,要想取一个有实际意义的名称,清晰地表达变量或者常量的用途,25或者30个字符应当足够了。423类(ClasS)命名a)名字应该能够标识事物的特性。b)名字尽量不使用缩写,除非它是众所周知的。C)名字可以有两个或者三个单词组成,但通常不应多于三个。d

9、)在名字中,所有单词第一个字母大写。例如ISSUPerUser,包含ID的,ID可以全部大写,如CUStomerlDoe)使用名词或者名词短语命名类。少用缩写。g)不要使用下划线字符例:PiiblicclassHleStreamPublicclassButtonPubliccIassString424接口(Interfece)命名和类命名规X相同,惟一区别是接口在名字前加之T前缀。例:interface!Map;或者interfaceIMapDocument:425方法(Method)命名和类命名规X相同;4.2.6命名空间(NameSpace)命名和类命名规X相同;427属性(PrcPert

10、y)命名和类命名规X相同;43注释规X431a)注释要求英文及英文的标点符号。b)注释中,应标明对象的完整的名称及其用途,但应避免对代码过于详细的描述。C)每行注释的最大长度为100个字符。d)将注释与注释分隔符用一个空格分开。e)不允许给注释加外框。f)编码的同时书写注释。g)重要变量必须有注释。h)变量注释和变量在同一行,所有注释必须对齐,与变量分开至少四个“空格”键。如:in(rn_jLevdnLjCount;nLjLevd.re*vdmJCount.untoftreeitemsstringm_strSql;/SQLi)典型算法必须有注释。j)在循环和逻辑分支地方的上行必须就近书写注释。

11、k)程序段或者语句的注释在程序段或者语句的上一行I)在代码交付之前,必须删掉暂时的或者无关的注释。m)为便于阅读代码,每行代码的长度应少于100个字符。4.32自建代码文件注释对于自己创建的代码文件(如函数、脚本),在文件开头,普通编写如下注释:泮*FiIeName:Copyright(C)2004-xxxx*公司技术开辟部WriterCreateDate:Revrriter:RewriteDate:ImpactMainContent(FunctionNamePararneters、returns)433模那类渔释模块开始必须以以下形式书写模块注释:/ModuleID:模块编号,可以引用系统设

12、计中的模块编号/Depiction:/Author:作者中文名/CreateDate:V模块创建日期,格式:YYYY-MM-DD/如果模块只进行部份少量代码的修改时,则每次修改须添加以下注释:/RewriterDate:Start1:/*原代码内容*/Endl:将原代码内容注释掉,然后添加新代码使用以下注释:/AddedbyAdddate:添加日期,格式:YYYY-MM-DDStart2:/End2:如果模块输入输出参数或者功能结构有较大修改,则每次修改必须添加以下注释:/LogID:/depiction:对此修改的描述/Writer:修改者中文名/RewriteDate:模块修改日期,格式:

13、YYYY-MM-DDZ434类属性注释在类的属性必须以以下格式编写属性注释:/描述信息/435鹿注释在类的方法声明前必须以以下格式编写注释III/depiction:对该方法的说明III/paramname=III/对方法返回值的说明,该说明必须明确说明返回的值代表什么含义/Writer:作者中文名/CreateDate:43.6代码间注释代码间注释分为单行注释和多行注释:单行注释/*多行注释1多行注释2多行注释3*/代码中遇到语句块时必须添加注释(ifbr,fbgch,),添加的注释必须能够说明此语句块的作用和实现手段(所用算法等等)。44编码规则4.4.1错误检查规则a)编程中要考虑函数的各种执行情况,尽可能处理所有流程情况。b)检查所有的系统调用的错误信息,除非要忽略错误。C)将函数分两类:一类为与屏幕的显示无关,另一类与屏幕的显示有关。对于与屏幕显示无关的函数,函数通过返回值来报告错误。对于与屏幕显示有关的函数,函数要负责向用户发出警告,并进行错误处理。d)错误处理代码普通放在函数末尾。e)对于通用的错误处理,可建立通用的错误处理函数,处理常见的通用的错误。4.42 大括号规则将大括号放置在关键词下方的同列处,例如:4.43 小括号规则a)不要把小括号和关键词(if、W

展开阅读全文
相关资源
猜你喜欢
相关搜索

当前位置:首页 > IT计算机 > .NET

copyright@ 2008-2023 1wenmi网站版权所有

经营许可证编号:宁ICP备2022001189号-1

本站为文档C2C交易模式,即用户上传的文档直接被用户下载,本站只是中间服务平台,本站所有文档下载所得的收益归上传人(含作者)所有。第壹文秘仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对上载内容本身不做任何修改或编辑。若文档所含内容侵犯了您的版权或隐私,请立即通知第壹文秘网,我们立即给予删除!