net命名规范的不同
- 格式:doc
- 大小:28.00 KB
- 文档页数:4
基于.NET项目的代码书写规范要求书第一章主体命名规范外挂服务命名规范服务项目命名所有服务项目名使用ESrv(注意大小写)开头,第五位字母开始自订义,但是第五位字母必须大写。
比如ESrvDemo1,其中Demo1为自定义名称。
二、类成员访问权限规范所有类成员要严格的按照成员的使用性质,设置它们的访问修饰符,修饰符的意义如下:声明的可访问性意义l public //访问不l 受限制。
l protected //访问仅限于包含类或从包含类派生的类型。
l internal //访问仅限于当前程序集。
l protected internal //访问仅限于从包含类派生的当前程序集或类型。
l private //访问仅限于包含类型。
第二章代码书写规范一、代码注释规范1) .cs文件的注释所有.cs文件开头都要加上注释,写明文件创建时间、作者、用途概述等格式如下://********************************************************////创建日期: 2004.7.19//作者: XXX//功能说明:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX////********************************************************函数参数命名及过程注释参数一定要能说明要传递的意思,用对应的英文或相近的英文单词表示均小写开头。
所有的函数体开头都要加上注释,所以注释使用.NET注释规范,如下格式:/// <summary>/// 构造函数/// </summary>/// <param name="netPath">示例参数1</param>/// <param name="myPath">示例参数2</param>public UpgradeThread(string netPath, string myPath){程序语句。
.Net项⽬命名规范⽬录dotShare系统改造项⽬的建设过程中,将涉及到Visual 、Web站点,业务对象及数据库,同时项⽬⼈员包括设计⼈员、开发⼈员和测试⼈员等较多。
为了保持应⽤程序、组件、⽂件的⼀致性,便于阅读和管理代码和结构,提⾼开发效率和产品的标准化,特制订⼀套开发规范和标准(包括命名规范和编码规范)。
好的编码约定可使源代码严谨、可读性强且语意清楚,做到与其它语⾔约定相⼀致,并且提⾼直观性。
希望设计/开发⼈员严格遵守此套开发规范和标准,并落实到⾃⼰的设计与代码程序中。
命名规范将包括:编程命名规范,业务对象命名规范,数据库命名规范,Web站点结构命名规范等。
编码规范将包括:C#编码规范,第三⽅模块使⽤规范等本命名规范主要针对使⽤Visual (语⾔及C#语⾔)规范,即编程命名规范部分。
请注意:在本项⽬过程中,C#将作为⾸选语⾔,如⾮特别必要,不要选⽤。
变量命名的总原则是⼀个通⽤性的原则,本规范后续章节中的命名规则都应当符合这些总原则。
·变量名称应当准确完整地描述了变量的含义·名称应当反映了业务上的问题⽽不是技术上或编程上的解决⽅法·名称的长度应当⾜够长·名称的最后⼀部分应当有限定符·应当⽤Count, Index或Nbr代替Num, No.·循环计数变量的的名称应当有含义(如果循环语句的长度超过了两⾏或者存在着嵌套循环,尽量避免使⽤I,j,k之类的变量,应该使⽤有意义的变量)·临时变量的命名应当有意义·所有布尔型变量的命名能够直接从名称上看出为真的条件·枚举类型的变量名称应当包含了基础类型,能够⽅便的分辨变量的类型。
例如:⽤Color变量表⽰ ColorRed, ColorGreen枚据类型的值。
·命名的常量应当代表了抽象的实体⽽⾮他们所代表的值·从变量命名中应当可以看出变量的作⽤域是局部变量,模块变量或者全局变量·变量的名称中不同的单词⾸字母要⼤写,以⽅便阅读·如果不是绝对必须,尽量避免使⽤短的名称·如果变量中单词的缩写只能缩短⼀两个字符则使⽤单词的完全拼写·所有单词的缩写规则应当⼀致·名称具有误导性·两个不同的命名具有相似的含义·不同的命名拼写很相似,仅差⼀两个字符·在变量名称中不应当使⽤数字·完全和变量含义不相关的命名使⽤下⾯的三种⼤写标识符约定。
几种常见的软件命名规则收藏今天终于有时间可以不用加班,回来看电影,听歌。
筹划已久的博客,今天终于也迎来了第一篇有意义的文章,参考了网络上的一些文章,写的不好,再努力。
实际上命名规范是有很多的,也不是见到的就可以说的清楚,这里就就简单的介绍三种:匈牙利命名规范,Pascal,Camel:一、匈牙利命名规范:广泛应用于象Microsoft Windows这样的环境中。
几年以前,Charles Simonyi(他后来成为微软的著名程序员)设计了一种以前缀为基础的命名方法,这种方法后来称为"匈牙利表示法"以记念他.他的思想是根据每个标识符所代表的含义给它一个前缀.微软后来采用了这个思想,给每个标识符一个前缀以说明它的数据类型.因此,整型变量的前缀是n,长整型变量是nl,字符型数组变量是ca,以及字符串(以空类型结尾的字符数组)以sz为前缀.这些名字可能会非常古怪.比如说:lpszFoo表示"Foo"是一个指向以空字符为结尾的字符串的长整型指针. 这种方法的优点是使人能够通过变量的名字来辨别变量的类型,而不比去查找它的定义.遗憾的是,这种方法不仅使变量名字非常绕口,而且使改变变量类型的工作变得十分艰巨.在Windows3.1中,整型变量为16为宽.如果我们在开始时采用了一个整型变量,但是在通过30---40个函数的计算之后,发现采用整型变量宽度不够,这时我们不仅要改变这个变量的类型,而且要改变这个变量在这30--40个函数中的名字. 因为不切实际,除了一些顽固的Windows程序员外已经没有人再使用"匈牙利表示法"了.毫无疑问,在某种场合它依然存在,但大部分人现在已经抛弃它了.一般而言,输入前缀是一种糟糕的想法,因为它把变量于其类型紧紧地绑在了一起. 对于30行以下的函数,匈牙利方法一般有优势。
尤其是对界面编程,有优势。
但对于有强烈的算法要求、尤其是有很多抽象类型的C++程序,匈牙利方法简直是一个灾难。
软件产品版本号命名规范软件产品版本号命名规范1、⽬的规范软件产品版本号,避免软件测试、发布时软件各模块版本不兼容问题。
2、范围C3M平台软件及绿⾊⾏动管理平台。
3、命名规范软件产品版本号命名规范参考 .Net Framework风格的版本号命名格式,以:主版本号.次版本号.内部版本号.修订号四位表⽰。
软件初版时,版本号为:1.0.0.0。
主版本号:标识软件架构、设计思想,主版本号不同的程序集不可互换,即使具有相同名称也不可互换。
软件架构、设计思想改变或⼤量重写,主版本号加1。
主版本号改变,不⽀持向后兼容性,次版本号、内部版本号及修订号复位为0。
次版本号:当在原有基础上增加了部分功能,涉及数据库的改动,次版本号加1,内部版本号及修订号复位为0。
内部版本号:当软件各模块间接⼝变更时,内部版本号加1,修订号复位为0。
只要有某个或某⼏个模块的接⼝发⽣变动,所有模块的内部版本号统⼀增加1。
修订号:名称、主版本号、次版本号、内部版本号都相同,但修订号不相同的程序集可以完全互换。
以软件编译⽇期(⽉⽇)4位数字作为修订号,如10⽉5号,则为1005。
当天发布的多次软件,⽤后编译的软件程序完全替换前边编译的软件程序。
主版本号、次版号及内部版本号,其中任何⼀个如果需要变更,需要向软件负责⼈申请,由软件负责⼈确定。
软件负责⼈将统⼀修改软件产品版本号,并通知所有相关开发⼈员。
开发⼈员每次的改动必须写开发⽇志,注明改动了哪些东西,修正了哪些BUG,是否对其它模块有影响,是否对数据库有改动。
软件产品所需要的主版本号、次版本号、内部版本号,出现任何⼀个变更,软件产品需要整体升级。
4、软件模块版本号软件各模块需要独⽴的主版本号、次版本号、内部版本号,其中对公共模块或公共组件的版本号,为完全独⽴的版本号,与软件产品版本号的主版本号,次版本号,内部版本号⽆关。
对业务模块的版本号,其主版本号与软件产品的版本号⼀致,次版本号,内部版本号为独⽴版本号。
.NET开发规范编写:审核:批准:目录1.概述 (4)2.命名规范 (4)2.1.类、参数和方法的命名规范 (4)2.2.接口命名规范 (4)2.3.动态语言文件命名规则 (5)2.3.1.格式:性质_描述 (5)2.4.客户端JavaScript规范 (5)2.4.1.变量命名规范 (5)2.4.2.对象命名规范 (5)2.5.控件命名规范 (5)2.6.图片的命名原则 (6)2.7.数据库命名规范 (7)2.7.1.命名规范原则 (7)2.7.2.数据库规范 (7)2.7.3.表命名规范 (7)2.7.4.字段规范 (8)2.7.5.视图规范 (8)2.7.6.存储过程规范 (8)2.7.7.函数规范 (8)2.7.8.索引命名规范 (8)2.7.9.关联命名 (8)2.7.10.设计规范 (8)3.编码规范 (8)3.1.C#代码编写 (8)3.2.Request、Session、Application使用规范 (12)3.3.HTML标记语言编码规范 (12)3.4.注释规范 (12)3.5.异常规范 (15)1.概述为了保持应用程序、组件、文件的一致性,便于阅读和管理代码和结构,提高开发效率和产品的标准化,特制订一套开发规范和标准(包括命名规范和编码规范)。
命名规范将包括:类和参数的命名规范、接口命名规范、数据库命名规范、ASP命名规范、JavaScript命名规范、控件命名规范等。
编码规范将包括:C#编码规范、注释规范、HTML编码规范、编码规范、异常规范等。
2.命名规范2.1.类、参数和方法的命名规范2.1.1.用名词或名词短语命名类。
2.1.2.使用Pascal大写注记:Pascal 大小写形式-所有单词第一个字母大写,其他字母小写。
2.1.3.不要使用匈牙利命名法2.1.4.用有意义的,描述性的词语来命名变量- 别用缩写。
用name, address, salary等代替nam, addr, sal 。
Netsuite表结构说明一、概述Netsuite是一套全面的企业资源规划(ERP)和客户关系管理(CRM)软件系统,为企业提供了包括财务管理、采购、库存管理、销售和市场营销等一系列业务管理解决方案。
在Netsuite系统中,表结构作为数据库的核心组成部分,承载着企业数据的存储和管理功能。
本文将对Netsuite表结构做出详细说明。
二、表结构概述1. Netsuite表结构采用关系型数据库设计,采用了一系列表来存储不同的业务数据。
每个表都包含了若干列,每一列对应着特定的数据字段。
在Netsuite系统中,表结构的设计遵循了数据库范式化的原则,确保数据的一致性和完整性。
2. 表结构采用了面向对象的设计理念,将不同业务实体进行抽象和归类,形成了一系列的对象表。
这种设计方法使得不同业务数据之间的关联和依赖更加清晰,提高了数据的管理和操作效率。
3. 在Netsuite系统中,表结构的命名规范明确,每个表都有一个唯一的标识符,并采用了一定的命名规则来保证表名的规范和统一,提高了系统的可维护性和扩展性。
三、表结构详解1. 主表和子表关系在Netsuite系统中,主表和子表的关系是系统中一个重要的设计特点。
主表包含了业务实体的基本信息,而子表则包含了主表的一对多关系数据。
通过主表和子表的关联,实现了复杂业务实体的管理和统一操作。
2. 数据字段类型在Netsuite系统中,数据字段的类型多种多样,包括了文本、数字、日期、布尔值、枚举等多种类型。
每种类型都有其特定的存储格式和操作规则,确保了数据的准确性和完整性。
3. 索引和约束Netsuite表结构中的索引和约束设计十分重要,通过索引可以提高数据的检索速度,而约束则可以确保数据的一致性和完整性。
系统中的各种索引和约束都经过精心设计,保证了系统的稳定性和性能。
四、表结构维护1. 表结构演进随着企业业务的发展和变化,Netsuite表结构也需要不断地进行演进和优化。
.NET中的命名规则(2010-07-21 17:16:29)转载分类:信息技术标签:杂谈名称空间的命名命名名称空间的一般规则如下:CompanyName.TechnologyName这样,我们看到的名称空间应该是这样的:Microsoft.OfficePowerSoft.PowerBuilder注意:这只是一个原则。
第三方公司可以选择其它的名字。
避免用公司名称或其它著名品牌的名称作为名称空间的前缀,这样会造成两个公布的名称空间有同一个名称的可能性。
例如:将微软提供的Office自动类命名为Microsoft.Office使用Pascal大写方式,用逗号分隔逻辑成分。
例如:Microsoft.Office.PowerPoint如果你的品牌使用的是非传统大写方式,那么一定要遵循你的品牌所确定使用的大写方式,即使这种方式背离了通常的名称空间大写规则。
例如:NeXT.WebObjectsee.cummings类和类成分的命名类的命名原则是用名词或名词短语命名类,使用Pascal大写。
减少类名中缩写的使用量。
不要使用任何类前缀(比如C),不要使用带下划线的字符。
例如:public class FileStream {}public class Button {}public class String {}变量的命名名称中各单词首字母均为大写。
例如:FindLastRecordRedrawMyForm在内部范围中避免使用与外部范围中的名称相同的名称。
若访问错误变量,则会产生错误结果。
若变量与同一名称的关键字冲突,则必须在关键字前加适当的类型库以作标识。
例如:若有一个名为 date 的变量,只能通过调用System.Date来使用内部Date函数。
函数和方法的命名函数和方法的命名应该以动词开始,使用Pascal大写。
不要使用带下划线的字符。
例如:InitNameArrayCloseDialog接口命名原则使用名词或名词短语,或者描述行为的形容词来命名接口,使用Pascal大写。
版本控制比较普遍的 3 种命名格式 :一、GNU 风格的版本号命名格式 :主版本号 . 子版本号 [. 修正版本号 [. 编译版本号 ]]Major_Version_Number.Minor_Version_Number[.Revision_Number[.Build_Num ber]]示例 : 1.2.1, 2.0, 5.0.0 build-13124二、Windows 风格的版本号命名格式 :主版本号 . 子版本号 [ 修正版本号 [. 编译版本号 ]]Major_Version_Number.Minor_Version_Number[Revision_Number[.Build_Numb er]]示例: 1.21, 2.0三、.Net Framework 风格的版本号命名格式:主版本号.子版本号[.编译版本号[.修正版本号]]Major_Version_Number.Minor_Version_Number[.Build_Number[.Revision_Num ber]]版本号由二至四个部分组成:主版本号、次版本号、内部版本号和修订号。
主版本号和次版本号是必选的;内部版本号和修订号是可选的,但是如果定义了修订号部分,则内部版本号就是必选的。
所有定义的部分都必须是大于或等于0 的整数。
应根据下面的约定使用这些部分:Major :具有相同名称但不同主版本号的程序集不可互换。
例如,这适用于对产品的大量重写,这些重写使得无法实现向后兼容性。
Minor :如果两个程序集的名称和主版本号相同,而次版本号不同,这指示显著增强,但照顾到了向后兼容性。
例如,这适用于产品的修正版或完全向后兼容的新版本。
Build :内部版本号的不同表示对相同源所作的重新编译。
这适合于更改处理器、平台或编译器的情况。
Revision :名称、主版本号和次版本号都相同但修订号不同的程序集应是完全可互换的。
这适用于修复以前发布的程序集中的安全漏洞。
net命名规范的不同
在你的代码中使用注释语句和下边就要讲的统一命名法则是一个很好的习惯,它们会使你的代码更加通用。
我(作者)已经在微软工作了近五年的时间了。
我不知道你是否跟我一样,在集成和除BUG时遇到很多问题----因为开发者没有遵守统一的命名法则和写注释语句。
在以前版本的Visual Studio中,微软曾建议使用匈牙利命名法来写代码,并鼓励开发这位写出统一格式的代码而使用相同的法则。
例如:
变量
命名
CString
SzString
char
CmyChar
char*
PmyChar
Long
LMyVariable
LPCSTR
LpStr
Int
NMyNumber
在最近发布的.net和它的编程语言中,微软更换了他的这一法则。
如果你用过Delphi编程,你会看到新的法则与Delphi(Pascal)有些相似。
为避免代码冲突(这样做也会让你的代码更为通用),就要使用命名法则,这是一个很好的编程习惯。
好啦,这里介绍一些常用的法则。
◆命名变量、方法、以及属性
变量、方法和属性的名称的第一个字母应该大写,并且名称应该能表达出它们的用途(或者说是意义)。
变量
.NET 命名
匈牙利命名
描述
Cstring
EmployeeName
szName
Name of an employee.
Int
AttendanceCounter
nCounter
A counter of type long.
Long
NumberOfBytes
lBytes
A long type variable stores bytes.
有时我们习惯于在定义中使用下划线"_",例如:Add_Data(int a, int b). 按照新的命名法则,这不是一个好的编程习惯,虽然它并没有错。
你应该将定义Add_Data 改为AddData。
这不是微软的标准,你也不是必须按照这些法则。
但是,在一些地方你会明白下边这些法则的合理性。
就我个人而言,我更喜欢匈牙利命名法。
当然,变量也使用同样的法则。
如果你记得匈牙利命名法的话,一个布尔型的变量定义以"b"打头,比如:
BOOL bFlag = TRUE;
新的法则不推荐使用Flag 和"b":
bool IsFileFound = true;
你可以浏览一下MSDN,那里边有更多有关新的法则的说明。
◆命名组件以及集合(Assemblies)
为避免代码冲突, 按照命名法则给你的库(在 .NET 中称为assembly)命名是一个良好的编程习惯。
假定你是MindCracker 公司的,你在开发一个用于扩充C# database 类的库, 把它的名字命名为MindCracker.DatabaseAssembly.ADOSet 要比MyAssembly.Database.ADOSet好的多。
再假定你的库有一个方法,它是从表中读取数据,并返回一个数据集。
你如果取名为DataSet return_data()的话,改为DataSet ReturnData()好啦.
你还应该在命名中遵循一个统一的单词顺序。
例如,你有俩个表,分别为Employee 和Manager ,并且
你还为它们分别定义了一个向表里边插入一条记录的方法,那么方法名AppendEmployee 和AppendManager 要比AppendEmployee 和ManagerAppend要好。
◆循环
循环或者是其它块儿结构应该对齐左右大括号,就像下边这样:
for (i = 0; i < 100; i++)
{
...
}
或者
for (i = 0; i < 100; i++){
...
}
我更喜欢的二种方法,因为很容易清楚一个块儿结构和嵌套块儿结构。
◆匈牙利命名法(efoxxx附)
匈牙利命名法是一名匈牙利程序员发明的,而且他在微软工作了多年。
此命名法就是通过微软的各种产品和文档传出来的。
多数有经验的程序员,不管他们用的是哪门儿语言,都或多或少在使用它
这种命名法的基本原则是:
变量名=属性+类型+对象描述
即一个变量名是由三部分信息组成,这样,程序员很容易理解变量的类型、用途,而且便于记忆。
下边是一些推荐使用的规则例子,你可以挑选使用,也可以根据个人喜好作些修改再用之。
⑴属性部分:
全局变量:g_
常量:c_
类成员变量:m_
⑵类型部分:
指针:p
句柄:h
布尔型: b
浮点型: f
无符号:u
⑶描述部分:
初始化:Init
临时变量:Tmp
目的对象:Dst
源对象:Src
窗口:Wnd
下边举例说明:
hwnd:h表示句柄,wnd表示窗口,合起来为“窗口句柄”。
m_bFlag:m表示成员变量,b表示布尔,合起来为:“某个类的成员变量,布尔型,是一个状态标志”。