开发人员手册VSNET开发规范篇模板.doc
《开发人员手册VSNET开发规范篇模板.doc》由会员分享,可在线阅读,更多相关《开发人员手册VSNET开发规范篇模板.doc(52页珍藏版)》请在咨信网上搜索。
1、密级:秘密 开 发 人 员 手 册 -VS.NET开发规范篇文档最终修订者及日期:孙立新-3-16本版文件同意人及日期:浪潮集团山东通用软件目录1导言51.1目标51.2适用范围51.3术语定义51.4参考资料51.5版本更新统计52使用开发工具:63程序源代码风格定义63.1代码结构风格63.2注释风格73.2.1单行注释83.2.2多行注释83.2.3文档型注释83.2.4文档型注释规范113.3代码书写风格143.3.1缩进143.3.2空行143.3.3换行153.3.4空格153.3.5花括号164命名规范164.1大写规则164.2区分大小写174.3缩写184.4措词194.5避
2、免类型名称混淆204.6命名空间命名规范224.7类命名规范234.8接口命名规范244.9属性命名规范254.10枚举类型命名规范254.11静态字段命名规范254.12参数命名规范264.13方法命名规范264.14属性命名规范264.15事件命名规范284.16数据库对象命名规范294.16.1数据库名(开发过程中)294.16.2数据库表294.16.3字段304.16.4存放过程命名约定314.16.5触发器(插入,更新,删除)命名约定314.16.6视图命名约定314.16.7自定义数据类型命名约定314.16.8自定义函数命名约定324.17数据库表结构设计规范334.18数据库
3、存放过程编写规范345界面规范345.1总则345.2遵从标准345.3色彩搭配355.4屏幕大小355.5主控页面355.5.1主页:登录窗口355.5.2主操作页分成三个区域:标题菜单区、系统管理区、操作区365.5.3浏览器365.6多种页面模板应用场景375.6.1字典类375.6.2单据类385.6.3管理类395.6.4索引类405.6.5Tab页类405.6.6响应式窗口类405.6.7查询结果/报表类406提醒信息规范416.1总则416.2提醒信息417热键定义、帮助及使用规范417.1总则417.2规范418单元测试规范(从开发人员角度)428.1总则428.2测试规范42
4、9配置管理规范(从开发人员角度)439.1总则439.2开发前准备439.3开发过程中规则4410程序模板4410.1总则4410.2字典模板4510.3单据模板4510.4查询模板4511其它规则及提议461 导言1.1 目标本文档是为基于Microsoft企业Visual Studio .Net - C#.Net系列开发工具进行软件开发一个规范性文件。其目标是: 确保软件开发过程中有一个统一标准能够进行参考:包含类库、公共接口、设计模式、命名规范等。 能够合理使用公用资源1.2 适用范围本文档关键是基于现在三层架构开发模式中SmartClient方法进行描述,并一样适合于传统三层架构:A1
5、.3 术语定义可访问性修饰符:public(公有)、internal(内部公有)、proected(受保护)、protected internal(受保护或内部公有)、private(私有)。在此约定好中英文对照名称。非私有包含:公有、内部公有、受保护、受保护或内部公有。1.4 参考资料1. C# Language Specification1.2.doc2. C# Language Specification 2.0.doc1.5 版本更新统计版本/修订版修改确定日期修改内容概述起草人审核人备注1.0-10初始版本鞠强曲丽君2.0-03代码风格章节调整命名规范细化样式调整孙立新2 使用开发工
6、具: Microsoft Visual Studio .Net - C#.Net3 程序源代码风格定义源代码风格规范是在编写源代码文件时,对于书写格式和规则统一要求。编写源代码最基础目标是能够经过编译生成可实施程序。另外,源代码另一个关键目标是为了阅读,源代码不仅仅是为了编译器能够读懂,同时也是为了人能够读懂,且易于读懂。这就如写文章句读、段落、章节等类似,假如没有一个良好书写风格和习惯,不仅仅会使写出文章难以阅读,而且可能会造成不少曲解。有句话叫“文如其人”,代码也一样是“文如其人”。另外,作为一个协作亲密开发团体,很有必需保持一致代码书写风格,它有利于团体开发保持高效(沟通交流、代码阅读、
7、工作交接、工作延续性等方面)。3.1 代码结构风格对于每一个代码文件(*.cs),它内容分为以下两个部分:u 使用命名空间u 类型定义使用命名空间,要求必需全部申明在代码文件最前方。提议.net framework中定义命名空间放在最上面,然后依据和目前代码关系远近依次排列,对于引用命名空间,根据引用起源分段列示,段和段之间用空行分隔。示例图以下:using System;using System.Collections;using System.Collections.Generic;using DevExpress.XtraTreeList;using DevExpress.XtraTre
8、eList.Nodes;using Genersoft.Platform.Core.Common;using Genersoft.Platform.Core.Error;31 使用命名空间代码示例在类型定义部分,一个代码文件标准上只包含一个以下类型定义:类、接口、结构、枚举。这么有利于结构出条理清楚代码文件结构,一目了然。对于委托定义,可考虑在一个代码文件中集中定义内聚度较高一类枚举。对于类定义,根据一下次序定义:u 常量u 字段u 结构函数u 析构函数u 属性u 方法u 事件全部类组员必需显式申明访问修饰限定符(public、internal、protected、private)。为使类型含
9、有良好封装性,其中字段类型只能申明为private。对于接口和结构体定义,其组员申明次序和类定义相同。每行代码只许可写一条语句。每行代码写多条语句往往会造成调试定位、注释和阅读困难。3.2 注释风格传统注释风格:单行注释符号“/”和多行注释符号“/* */”在C#中仍然能够使用。在.NET中,提供了额外XML文档注释标识(Tags for Documentation Comments)。3.2.1 单行注释单行注释,即形式为“/”注释。单行注释用于方法内代码注释。如对局部变量申明注释或代码行、代码段注释。单行注释可单独一行,假如仅仅针对一句注释,且不影响换行,可放于代码行后部。单行注释也能够用
10、于临时屏蔽不用代码行,在开发完成后应立即清理。特殊,单行注释用于代码文件申明注释,见代码文件注释。3.2.2 多行注释多行注释,即形式为“/* */”注释。通常,不提议在代码中使用多行注释。多行注释可用于临时屏蔽不用代码行,在开发完成后应立即清理。3.2.3 文档型注释文档型注释,即XML文档注释标识(Tags for Documentation Comments),该类注释是.Net定义Xml标签,在申明接口、类、方法、属性、字段全部应该使用该类注释,除了在阅读代码时了解代码语义之外,可经过该类注释生成代码类库帮助文档(*.chm)。这些标识包含以下表全部内容:文档标签使用方法示意功效说明d
11、escriptiondescription:对象摘要。应该用于描述类型组员。使用 以提供相关类型本身信息。descriptionname:方法参数名。description:参数说明。应该用于方法申明注释中,以描述方法一个参数。 name:引用参数名。 标识为您提供了一个指示词为参数方法。能够处理 XML 文件,从而用某种独特方法格式化该参数。descriptionmember:对可从目前编译环境中获取异常引用。编译器检验到给定异常存在后,将 member 转换为输出 XML 中规范化元素名。description:异常使用条件说明。 标识使您能够指定类能够引发异常。 descriptionD
12、escription:返回值说明。 标识应该用于方法申明注释,以描述返回值。cref = member:对能够经过目前编译环境进行调用组员或字段引用。编译器检验到给定代码元素存在后,将 member 传输给输出 XML 中元素名。使您得以从文本内指定链接。使用 指示期望在“请参阅”一节中出现文本。cref = member:对能够经过目前编译环境进行调用组员或字段引用。编译器检验到给定代码元素存在后,将 member 传输给输出 XML 中元素名。使您得以指定期望在“请参阅”一节中出现文本。使用 从文本descriptiondescription:代码示例。使用 标识能够指定使用方法或其它库组
13、员示例。通常情况下,这将包含到 标识使用。ctext text:指示为代码文本。为您提供了一个将说明中文本标识为代码方法。使用 将多行指示为代码contentcontent:标识为代码段文本。 记为您提供了一个将多行指示为代码方法。使用 指示应将说明中文本标识为代码 property-descriptionproperty-description :属性取值说明。 标识使您得以描述属性。请注意,当在 Visual Studio .NET 开发环境中经过代码向导添加属性时,它将会为新属性添加 标识。然后,应该手动添加 标识以描述该属性所表示值。contentContent:段落文本。用于诸如 或
14、 等标识内,使您得以将结构添加到文本中。filename 包含文档文件名。该文件名可用路径加以限定。将 filename 括在单引号中 ( )。 Tagpath:filename 中指向标识名标识路径。将此路径括在单引号中 ( )。 name 注释前边标识中名称说明符;名称含有一个 id。 id 在注释之前标识 id。将此 id 括在双引号中 ( )。 标识使您得以引用描述源代码中类型和组员另一文件中注释。这是除了将文档注释直接置于源代码文件中之外另一个可选方法。 标识使用 XML XPath 语法。相关自定义 使用方法,请参阅 XPath 文档。 term description term
15、description term :定义项,该项将在 text 中定义。 description:目符号列表或编号列表中项或 term 定义。 块用于定义表或定义列表中标题行。定义表时,只需为标题中项提供一个项。列表中每一项用 块指定。创建定义列表时,既需要指定 term 也需要指定 text。不过,对于表、项目符号列表或编号列表,只需为 text 提供一个项。列表或表所拥有 块数能够依据需要而定。descriptioncref = member 对能够经过目前编译环境进行调用组员或字段引用。编译器检验到给定代码元素存在后,将 member 转换为输出 XML 中规范化元素名。必需将 memb
16、er 括在双引号 ( ) 中。 description 组员访问说明。 标识使您得以将组员访问记入文档。System.Security.PermissionSet 使您得以指定对组员访问。descriptiondescription:备注说明。 标识是能够描述相关类或其它类型备注概述信息。3.2.4 注释规范3.2.4.1 代码文件注释对于每一个代码文件(*.cs),在文件起始位置添加注释,用以申明该代码文件用途、版本修订历史、作者、创建日期和版权申明等信息。/ =/ 浪潮GS产品/ 功效用途定义。/ 请查看GS开发文档来了解相关这类型更多信息。/ =/ 日期 版本修改人 描述/ =/ 作者/
17、 日期/ 浪潮集团山东通用软件版权全部。保留全部权利。/ =32 代码文件注释示例3.2.4.2 类型定义注释在类型定义时,需要添加该类型功效用途说明注释。用途说明应为阅读者介绍该类型提供关键功效,并向使用者介绍该类使用时需要了解知识,不要泛泛而谈,内容空洞,应付了事。使用“”标签,内部可依据需要添加合适标签,方便更清楚表示。/ / 安全管理服务调用接口工厂。用于为调用者创建。/ 依据配置文件SecurityClientConfiguration小节定义配置信息,创建对应服务实现。/ 若调用是SecurityClientFactory.GetClient()方法,是获取小节中UsingClie
18、nt属性指定服务实现。/ public static class SecurityClientFactory 33 类型定义注释示例生成类库文档样式示例:34 类型定义注释生成文档样式示例3.2.4.3 组员申明注释在类内部,对于组员申明,注释应能够说明组员功效用途,假如组员带有参数和返回值,应说明对应含义。功效用途使用“”标签。参数使用“”标签,返回值使用“”标签,另可依据组员调用应注意问题和相关知识进行说明,可采取“” 标签进行备注说明,采取“” 标签提供编程Demo。示例以下:/ / 获取指定配置安全管理服务调用接口。/ / 配置标识。对应于配置项中Code属性。/ 安全管理服务调用接口
19、。/ 假如是程序识别错误,将会抛出该类型异常。/ / 目前途序已经提供了三种服务调用实现,分别是:“当地调用(Local)”、“Web服务调用(WS)”、“Remoting调用(Remoting)”。/ / / ISecurityServiceClient serviceClient = / SecurityClientFactory.GetClient(SecurityClientFactory.WebService);/ public static ISecurityServiceClient GetClient(string configID) 35 类型定义注释代码示例生成类库文档样式
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 开发人员 手册 VSNET 开发 规范 模板
1、咨信平台为文档C2C交易模式,即用户上传的文档直接被用户下载,收益归上传人(含作者)所有;本站仅是提供信息存储空间和展示预览,仅对用户上传内容的表现方式做保护处理,对上载内容不做任何修改或编辑。所展示的作品文档包括内容和图片全部来源于网络用户和作者上传投稿,我们不确定上传用户享有完全著作权,根据《信息网络传播权保护条例》,如果侵犯了您的版权、权益或隐私,请联系我们,核实后会尽快下架及时删除,并可随时和客服了解处理情况,尊重保护知识产权我们共同努力。
2、文档的总页数、文档格式和文档大小以系统显示为准(内容中显示的页数不一定正确),网站客服只以系统显示的页数、文件格式、文档大小作为仲裁依据,平台无法对文档的真实性、完整性、权威性、准确性、专业性及其观点立场做任何保证或承诺,下载前须认真查看,确认无误后再购买,务必慎重购买;若有违法违纪将进行移交司法处理,若涉侵权平台将进行基本处罚并下架。
3、本站所有内容均由用户上传,付费前请自行鉴别,如您付费,意味着您已接受本站规则且自行承担风险,本站不进行额外附加服务,虚拟产品一经售出概不退款(未进行购买下载可退充值款),文档一经付费(服务费)、不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
4、如你看到网页展示的文档有www.zixin.com.cn水印,是因预览和防盗链等技术需要对页面进行转换压缩成图而已,我们并不对上传的文档进行任何编辑或修改,文档下载后都不会有水印标识(原文档上传前个别存留的除外),下载后原文更清晰;试题试卷类文档,如果标题没有明确说明有答案则都视为没有答案,请知晓;PPT和DOC文档可被视为“模板”,允许上传人保留章节、目录结构的情况下删减部份的内容;PDF文档不管是原文档转换或图片扫描而得,本站不作要求视为允许,下载前自行私信或留言给上传者【a199****6536】。
5、本文档所展示的图片、画像、字体、音乐的版权可能需版权方额外授权,请谨慎使用;网站提供的党政主题相关内容(国旗、国徽、党徽--等)目的在于配合国家政策宣传,仅限个人学习分享使用,禁止用于任何广告和商用目的。
6、文档遇到问题,请及时私信或留言给本站上传会员【a199****6536】,需本站解决可联系【 微信客服】、【 QQ客服】,若有其他问题请点击或扫码反馈【 服务填表】;文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“【 版权申诉】”(推荐),意见反馈和侵权处理邮箱:1219186828@qq.com;也可以拔打客服电话:4008-655-100;投诉/维权电话:4009-655-100。