DotNet-版本号命名约定
DotNet编码规范
.NET编码规范文档信息文档编号：.NET编码规范文档名称：.NET编码规范文档类别：文档模板文件密级：机密目录1 概述 (1)1.1 编写目的 (1)1.2 预期读者 (1)1.3 适用范围 (1)2 代码规范举例 (1)3 命名指南 (1)4 大写样式 (1)5 缩写 (2)6 命名空间命名指南 (3)7 类命名指南 (4)8 接口命名指南 (5)9 参数命名指南 (7)10 方法命名指南 (7)11 属性命名指南 (8)12 措词 (11)1概述1.1编写目的本文描述了.NET开发中的有关包、类、接口、方法、实例变量、变量和常量的命名规则，用于规范.NET编程过程中的命名和代码书写规范。
1.2预期读者开发组全体成员。
1.3适用范围适用于开发组所有基于.NET开发的项目2代码规范举例3命名指南一致的命名模式是托管类库中可预知性与可发现性最重要的元素之一。
对这些命名指南广泛的使用和理解将消除许多最常见的用户问题。
本主题提供.NET Framework 类型的命名指南。
对于每个类型，还应该注意关于大写样式、区分大小写和措词的一些通用规则。
4大写样式使用下面的三种大写标识符约定。
Pascal 大小写将标识符的首字母和后面连接的每个单词的首字母都大写。
可以对三字符或更多字符的标识符使用Pascal 大小写。
例如：BackColorCamel 大小写标识符的首字母小写，而每个后面连接的单词的首字母都大写。
例如：backColor大写标识符中的所有字母都大写。
仅对于由两个或者更少字母组成的标识符使用该约定。
例如：System.IOSystem.Web.UI可能还必须大写标识符以维持与现有非托管符号方案的兼容性，在该方案中所有大写字母经常用于枚举和常数值。
一般情况下，在使用它们的程序集之外这些字符应当是不可见的。
5缩写为了避免混淆和保证跨语言交互操作，请遵循有关区缩写的使用的下列规则：∙不要将缩写或缩略形式用作标识符名称的组成部分。
质量体系软件版本号命名规则参考标准
质量体系软件版本号命名规则参考标准在软件开发中，版本命名规则是确保软件版本管理和追踪的重要手段。
对于质量体系软件，其版本号命名规则尤为重要，因为它不仅关系到软件本身的开发、维护和升级，还涉及到软件与质量管理体系的兼容性和一致性。
一般而言，软件版本号命名规则应遵循简洁、明确、易于理解的原则。
常见的版本号命名规则包括“主版本号.次版本号.修订号”的形式，如“1.2.3”。
其中，主版本号表示软件的主要功能或架构的变更；次版本号表示在主要功能不变的情况下，软件的新增功能或优化；修订号则用于表示软件的细微修改或bug修复。
对于质量体系软件，其版本号命名规则可以参考以下建议：1.引入“质量级别”标识：在版本号中加入一个表示质量级别的标识，如“Q”（代表“质量”）。
这样，版本号就可以表示为“Q1.2.3”，其中“Q”表示这是一个质量体系软件。
2.质量级别与主版本号关联：质量级别可以作为主版本号的一部分，表示软件在质量管理方面的重大改进或变更。
例如，“Q1.0.0”表示软件在质量管理方面进行了重大升级，而“Q1.1.0”则表示在保持质量管理水平的基础上，软件增加了新的功能或优化。
3.遵循语义化版本控制：语义化版本控制（Semantic Versioning）是一种广泛采用的版本号命名规则，它强调版本号的语义化，使得版本号的变化能够清晰地反映出软件的变化内容。
质量体系软件可以借鉴这种规则，确保版本号的变化能够准确反映软件在质量管理方面的改进和变化。
总之，制定一个合理的版本号命名规则对于质量体系软件的开发和维护至关重要。
通过引入质量级别标识、关联质量级别与主版本号以及遵循语义化版本控制等方法，可以确保版本号能够清晰地反映出软件在质量管理方面的改进和变化，从而提高软件的质量和可靠性。
DotNet项目组编码规范
一．程序代码的注释1．存储过程的头部注释每一个存储过程都要写注释，写在最前面。
如/*Author： BillCreate Time： 2003-06-16 17:04Last Modify Time： 2003-06-16 17:13Version： 1.0.01Action describe：Memo：*/2．存储过程的代码内部注释存储过程的内部需要视情况添加注释，简单说明其功能、设计思想、算法等等。
如：/* SET NOCOUNT ON */3． CS文件的头部注释每一个.CS文件都要写注释，写在CS文件的最前面。
如/*File Name（文件名）： ClientServiceS.csStorage Path（存储路径）： Capitalnet_MIS\EntityDAO\Author（作者）： BillCreate Time（建立日期及时间）： 2003-06-16 17:04Last Modify Time（最后修改日期及时间）： 2003-06-16 17:13File Version（本文件版本号）：X.X.XXX 1.0.01File Action describe（文件功能描述）：客户服务实体访问层File Memo（备注）：*/4．类的注释为你定义的类写详细的注释，包括作者、时间、版本修订信息、基本的算法，如：/// <summary>/// 类的简单描述/// </summary>5．类成员的注释每一个类的成员，如变量、属性等都要加相应的注释。
6．方法的注释为你定义的每一个函数写详细的注释，包括输入输出参数说明、返回值说明、函数功能说明：/// <summary>/// 取得本帐期的帐单/// </summary>/// <param name="contractGuid">合同Guid</param>/// <param name="date">本帐期日期</param>/// <returns>帐单列表</returns>public static ContractPaidListData CalculateThisPaid(string contractGuid,DateTime date){ }7．代码内部的注释关键代码必须加注释，简单说明其功能、设计思想、算法等等。
版本号命名规则
版本命名规范1. 版本命名规范软件版本号由四部分组成：第一个1为主版本号第二个1为子版本号第三个1为阶段版本号第四部分为日期版本号加希腊字母版本号希腊字母版本号共有5种，分别为：base、alpha、beta、RC、release。
例如：1.0.0.081015_ release常规：完全的版本号定义，分三项：：<主版本号>.<次版本号>.<修订版本号>，如 1.0.02. 版本号定修改规则主版本号(1)：当功能模块有较大的变动，比如增加多个模块或者整体架构发生变化。
此版本号由项目决定是否修改。
子版本号(1)：当功能有一定的增加或变化，比如增加了对权限控制、增加自定义视图等功能。
此版本号由项目决定是否修改。
阶段版本号(1)：一般是 Bug 修复或是一些小的变动，要经常发布修订版，时间间隔不限，修复一个严重的bug即可发布一个修订版。
此版本号由项目经理决定是否修改。
日期版本号(051021):用于记录修改项目的当前日期，每天对项目的修改都需要更改日期版本号。
此版本号由开发人员决定是否修改。
希腊字母版本号(beta):此版本号用于标注当前版本的软件处于哪个开发阶段，当软件进入到另一个阶段时需要修改此版本号。
此版本号由项目决定是否修改。
3. 文件命名规范文件名称由四部分组成：第一部分为项目名称，第二部分为文件的描述，第三部分为当前软件的版本号，第四部分为文件阶段标识加文件后缀，例如：rongliaoRCS 1.0.0.081015_release.apk，此文件为项目外包平台的测试报告文档，版本号为：1.0.0.081015_ release。
版本号命名规范v1.0
版本号命名规范;1介绍(INTRODUCTION) (4)1.1目的(P URPOSE) (4)1.2过程总体概述(P ROCESS O VERVIEW) (4)1.3职责分工 (4)1.3.1项目经理 (4)1.3.2项目组成员 (4)1.3.3QA (5)1.3.4PMO (5)1.4文档编号命名规范 (5)1.5代码包编号命名规范 (5)1.6基线命名规范 (6)1.6.1项目里程碑说明 (6)1.6.2基线命名规范 (6)1.7分支命名规范 (7)华为版本号说明 (8)1 对"VXXX"的说明 (8)2. 对"RXXX"的说明 (8)3. 对"LLL"的说明 (9)4. 对"CXX"的说明 (9)5. 对"BXXY"的说明 (9)6. 对"SPXX"的说明 (9)1 介绍(Introduction)1.1目的(Purpose)规范项目过程中的文档、代码、基线、分枝的命名规范，统一版本号的命名。
1.2过程总体概述(Process Overview)本规范介绍了内部版本号和外部版本号，外部版本号为对外发布的版本，参照客户提供的版本号，本规范重点介绍内部版本号的由来及规范，项目过程中的文档代码都需要上传到svn上，并在项目里程碑阶段进行基线，项目的成员通过命名能清晰的知道版本的内容和阶段，达到对版本的号的规范。
1.3职责分工1.3.1项目经理●与客户确定外部版本号和版本号缩写（可参见sow）●明确外部版本号的缩写并作为内部项目名称使用（可参见sow）●划分每个版本的迭代层次●建库时依据制定的版本号申请建库●对项目过程中的版本号进行监控和执行1.3.2CMO●当单个配置项经过内部评审外部确认结束，可以作为后续活动开始的依据时对当前的配置项基线化●识别哪些属于配置项，需要进行基线化即打标签●当到达里程碑结束时，检查当前的基线文件夹内的配置项是否齐全，当达到里程碑的结束要求时，对基线文件夹打标签1.3.3项目组成员●每次打包时依据版本号命名规范进行命名●每次上传的文档、代码依据版本命名规范命名●维护项目过程中的版本号1.3.4QA●制定版本命名规范并进行维护●按照质量保证计划进行过程审计和产品审计1.3.5PMO●当项目命名规范发生较大偏差时进行纠正和改进●审批版本命名规范并进行正式下发1.4文档编号命名规范文档编号一般由四个部分组成：第一部分：公司名称。
项目版本号命名规则
项目版本号命名规则
一般来说，项目版本号命名规则应符合以下几点：
1.使用数字表示，并且数字必须递增。
一般而言，第一个版本号使用“1”，随后每次更新版本号，应递增一位。
如1、2、3等；
2.使用小数点符号。
即版本号之间用小数点“.”分隔，比如，1.0、1.1、1.2等；
3.版本号分为主版本号、次版本号和补丁版本号，通常用形如X.Y.Z 的三位数表示，且必须按照高位在前，低位在后的原则排列，如2.0.1；
4. 主版本号递增表示重大更新或编写重写，次版本号递增表示更新了功能，补丁版本号递增表示新增了一个或多个Bug修复；
5.主版本号的改动通常表明程序的架构、代码模块发生了重大变化，次版本号的改动表明程序的功能或者特性有新增或修改，补丁版本号的改动表明程序改善了一些细节问题；
6.版本号跳跃必须有规律，不允许发生不规范的跳跃；
7.尽量使用描述性的数字，比如用4.4.0来表示4.4版本，而不要用4.4.0.0来表示；
8.一定要严格遵守上面的原则，以免造成版本号的混乱，给管理带来极大的困难。
dotnet编码规范
.NET编码规范数据库规范辅助工具数据库设计、生成脚本、生成测试数据、ER图等，利用Sybase PowerDesign 12工具，保证所有的新建、修改、删除、添加的操作都生成包含日期标识的脚本文件，并上传到服务器版本控制器中设计规范✓设计表格默认包含4个字段：CreatedBy、CreateDate、LastUpdatedBy、LastUpdateDate（字段类型分别为nvarchar(20)、datetime、nvarchar(20)、datetime）✓所有可能包含中文的字段的字段类型设定为“nvarchar”，以防止在英文操作系统或数据库默认排序规则为非“Chinese_PRC_CI_AS”时，“varchar”类型可能造成的数据库乱码问题✓标识性字段的字段类型设定为“bit”，例如：“是否有效(IsEnable)”✓建议在可能会删除数据的表格设定一个删除标识，程序里，实现逻辑删除，而非数据库永久删除，除非客户需要✓当主键由一个以上字段构成时，建议使用自增ID作为主键，以便于分页。
✓通用性较高的表格建议添加几个用户自定义字段✓不强制做外键关联，但需要在程序里进行控制命名规范✓表名规范：数据库表格分为两种类型：系统表格与项目表格，系统表格均以“sys_”开头，后面跟相应意义的单词或缩写，例如系统数据字典大类为“sys_pubtype”。
1) 所有字符均由字母与“_”组成，若第二段较长可考虑用“_”隔成三段2) 所有字符均为小写✓字段名规范：字段名由若干单词构成，每个词的首字母大写。
例如：“TypeId”1)所有表示自增的字段结尾为“Id”2)字段名只能使用字母与数字✓视图名规范：规则与表名一致，但所有的视图需要加上后缀“_view”✓存储过程名规范：规则与表名一致，但所有的存储过程需要加上后缀“_proc”✓函数名名规范：规则与表名一致，但所有的函数需要加上后缀“_func”其他规范✓注释规范：存储过程的参数名作出用途注释，每个逻辑块的起始作出功能性注释，返回对象、类型作出注释✓缩进注释：默认使用“Tab”进行缩行项目规范辅助工具✓版本控制工具：SVN、Source Safe(6.0)✓代码生成工具：CodeSmith(Professional 3.2)设计规范✓说明1)目前框架使用MVC模式，每个解决方案分为一个网站和五个项目，项目包含IBRSCore、IBRSBusiness、Model、DAL、BLL，项目依赖关系依次递增。
DotNET编程规范
C#.NET编程规范——修订版（请使用 Office 2003 来阅读本文档，以获得最佳效果）我们应该知道规范对于系统的生命周期多么重要，试想如果每个程序员写的程序其他人都难以阅读，最后只能由他本人去维护、修改的话，软件开发将是什么样的噩梦。
MS为大家提供了FXCop工具，它用于自动检查代码的规范性、安全性甚至效率，所以，本文将围绕MS提供的C#.NET代码规范展开，以利于使用FXCop来自动校验我们的代码。
我以前曾经发布过《.NET编程规范个人总结》，但该文与FXCop的检测有相当的出入，所以我修改了该文，为此我深表歉意。
1、命名约定Pascal和Camel命名约定编程的命名方式主要有Pascal和Camel两种（Pascal：每个单词的首字母大写，例如ProductType。
Camel：首个单词的首字母小写，其余单词的首字母大写，例如productType）。
1.1、局部变量命名在primitive的局部变量命名时，使用Camel命名规则，比如：int type = 0;double count = 0;…对于string类型定义，通常使用str前缀＋Pascal命名的方式，比如string strSQL = string.Empty; 这是一种典型的命名SQL语句字符串的方式而对于此外的类型对象定义，通常的做法是使用obj前缀＋Pascal命名的方式，来告知我们这个变量是一个对象比如：Application obj Application = new Application();1.2、参数命名Camel命名规则，首字母小写1.3、类数据成员/属性命名数据成员命名以m开头＋Pascal命名方式；属性以Pascal命名比如class EQAppcalition{private ArrayList mWorksheetCollection = new ArrayList();public ArrayList WorksheetCollection{get{return this.mWorksheetCollection;}}}另外，在类的内部调用时，我们应该尽量加上this限定符，this在编辑环境中是蓝色的，更利于我们区分局部变量、参数或静态变量1.4、命名空间命名在.之间的限定字符串符合Pascal格式1.5、委托缩写委托的命名方式我常常以Pascal命名，或者可以在前面加入On比如public delegate void OnMouseUp (object sender, MouseEventArgs e);用于处理当Mouse Up时触发的委托1.6、自定义异常类我建议自定义异常类以Exception结尾，比如class EQException: Exception{…} 这是在我的ExcelQuicker控件中异常类的定义方式1.7、枚举枚举的命名是Pascal命名，不要像我在以前C++中命名时还在变量头加Enum，看上去挺别扭的。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
版本号命名约定
2009年02月
文档创建信息
文档修订记录
修改类型分为A - ADDED M - MODIFIED D– DELETED
目录
1.引言 ____________________________________________________________ 4 1.1.目的______________________________________________________________ 4 1.
2.背景______________________________________________________________ 4 1.
3.定义______________________________________________________________ 4
1.4.参考文献__________________________________________________________ 4
2.版本号命名规范 __________________________________________________ 4 2.1.命名方式__________________________________________________________ 4
2.2.变更条件__________________________________________________________ 5
3.版本号管理方式 __________________________________________________ 5
1.引言
1.1.目的
说明组件配置管理过程中的版本号命名方法，以便更好的进行组件配置管理工作。
本文档预期读者：组件开发人员、配置管理人员等。
1.2.背景
目前采用版本管理工具SVN、持续编译工具CCNet、CCTray来进行管理。
但随着组件的多时期多个版本的发布，对新旧版本的维护问题日趋增多，而且发布的程序集的各个版本为了以后升级方便都统一为Ver1.0.0.0，如此产生的问题就是一旦使用中出现了问题，不清楚所用组件程序集的具体版本号，也不方便定位版本和调试解决问题。
出于以上问题，要制定出一套版本号命名规范并且能够保证对日后升级不造成影响。
1.3.定义
1.4.参考文献
2.版本号命名规范
2.1.命名方式
(一)组件的程序集版本号命名规范如下：
<major version>.<minor version> .<build number>.<revision>
说明如下：
major version：主版本号
minor version：次版本号
build numbe：内部版本号
revision：修订号
(二)按此方式命名的程序集版本号示例如下：
[assembly: AssemblyVersion("1.2.0.0")]
说明如下：
版本 1.2.0.0 中的 1 表示主版本，2 表示次版本，内部版本号和修订号恒为0。
2.2.变更条件
(一)主版本号变更条件
1.组件架构升级、变动，主版本号加1
2.组件兼容性改变，主版本号加1
(二)次版本号变更条件
1.组件原有功能扩充完善，次版本号加1
2.组件增加新功能点，次版本号加1
(三)内部版本号及修订号任何版本都恒为0
3.版本号管理方式
随着组件多个版本的发布，对新旧版本的维护问题日趋增多，而且发布的程序集的各个版本为了以后升级方便原来都统一为1.0.0.0，如此产生的问题就是一旦使用中出现了问题，应用方不清楚所用组件程序集的具体版本号，也不方便定位版本源码和调试解决问题。
根据以上规定的版本号命名，可以有效地管理各个程序集的版本。
但如果程序集每次编译都带着不同的版本号，即每次都更新AssemblyInfo.cs文件中AssemblyVersion特性的值，这样会造成很严重的编译依赖问题。
当所依赖的程序集有所变动时，版本更新后必须要重新编译依赖此程序集的工程才可以使用更新后的功能，这样给应用方的使用带来很大不便。
为解决以上问题，最终讨论的决定方式如下：
(一)对外发布程序集的版本号统一为四位，但后两位恒为0。
如NEIP1.0.0.0、NEIP1.1.0.0，
内部版本号及修订号任何版本都恒为0，来避免维护中频繁升级导致版本号变化的
重新编译。
(二)为了在发现问题时能准确的找到此程序集版本的源代码，将程序集版本号连同版本
管理工具库标识号在程序集发布编译时写入程序集的备注信息中。
如NEIP1.0版本
发布时版本管理工具库标识号为100，则在发布编译时将“1.0.100”写入程序集的
备注信息中。
具体格式为：<主版本号>+”.”+<次版本号>+”.”+<版本管理工具库标识
号>。
(三)应用方使用中发现问题时提供Bug描述同时提供所使用程序集的备注信息中的版
本号标识以便于开发人员调试解决。