1 / 24
文档名称:

代码编写规范说明书.doc

格式:doc   大小:77KB   页数:24页
下载后只包含 1 个 DOC 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

代码编写规范说明书.doc

上传人:2286107238 2020/5/21 文件大小:77 KB

下载得到文件列表

代码编写规范说明书.doc

文档介绍

文档介绍:代码编写规说明书(c#.)(类)(Variable)(Class)(Interface)(Method)).:数据类型缩写表附件2:,变量,控件,类,,保证一致性、统一性而建立的程序编码规。,并有助于代码管理、平台的软件开发工作2围本规适用于开发组全体人员,作用于软件项目开发的代码编写阶段和后期维护阶段。)注释要求英文及英文的标点符号。b)注释中,应标明对象的完整的名称及其用途,但应避免对代码过于详细的描述。c)每行注释的最大长度为100个字符。d)将注释与注释分隔符用一个空格分开。e)不允给注释加外框。f)编码的同时书写注释。g)重要变量必须有注释。h)变量注释和变量在同一行,所有注释必须对齐,与变量分开至少四个“空格”键。如:intm_iLevel,m_iCount;//m_iLevel....treelevel//m_iCount....countoftreeitemsstringm_strSql;//SQLi)典型算法必须有注释。j)在循环和逻辑分支地的上行必须就近书写注释。k)程序段或语句的注释在程序段或语句的上一行l)在代码交付之前,必须删掉临时的或无关的注释。m)为便于阅读代码,每行代码的长度应少于100个字符。(如函数、脚本),在文件开头,一般编写如下注释:/******************************************************FileName:Copyright(c)2004-xxxx*********公司技术开发部Writer:createDate:Rewriter:RewriteDate:Impact:MainContent(FunctionName、parameters、returns)******************************************************/(类)注释模块开始必须以以下形式书写模块注释:///<summary>///ModuleID:<模块编号,可以引用系统设计中的模块编号>///Depiction:<对此类的描述,可以引用系统设计中的描述>///Author:作者中文名///CreateDate:<模块创建日期,格式:YYYY-MM-DD>///</summary>如果模块只进行部分少量代码的修改时,则每次修改须添加以下注释:///RewriterRewriteDate:<修改日期:格式YYYY-MM-DD>Start1:/*原代码容*////End1:将原代码容注释掉,然后添加新代码使用以下注释:///AddedbyAdddate:<添加日期,格式:YYYY-MM-DD>Start2:///End2:如果模块输入输出参数或功能结构有较大修改,则每次修改必须添加以下注释:///<summary>///LogID:<Log编号,从1开始一次增加>///depiction:<对此修改的描述>///Writer:修改者中文名///RewriteDate:<模块修改日期,格式:YYYY-MM-DD>///</summary>:///<summary>///<Propertiesdepiction>///</summary>///<summary>///depiction:<对该法的说明>///</summary>///<paramname="<参数名称>"