命名规范_C (Sharp)
- 格式:pdf
- 大小:142.78 KB
- 文档页数:6
c 语言命名规则(原创版)目录1.引言2.C 语言命名规则概述3.标识符的命名规则4.变量的命名规则5.函数的命名规则6.注释的命名规则7.结束语正文【引言】在编程语言中,C 语言是一种广泛使用的编程语言。
它被广泛应用于操作系统、嵌入式系统、游戏开发等领域。
了解 C 语言的命名规则对于编写清晰、易于维护的代码至关重要。
本文将详细介绍 C 语言的命名规则。
【C 语言命名规则概述】C 语言的命名规则主要涉及标识符、变量、函数和注释的命名。
其中,标识符是用于表示变量、函数、数组等的名称,它们需要遵循一定的命名规则。
【标识符的命名规则】在 C 语言中,标识符由字母(大小写均可)、数字和下划线组成。
但是,标识符不能以数字开头。
此外,C 语言中没有预先定义的关键字,因此,标识符可以与关键字相同,但这样可能会导致编译错误。
【变量的命名规则】变量是在程序中存储数据的容器。
在 C 语言中,变量的命名规则与标识符相同,可以包含字母、数字和下划线,但不能以数字开头。
同时,变量名应简洁明了,能够体现变量的用途。
【函数的命名规则】函数是 C 语言中用于实现特定功能的代码块。
函数的命名规则同样遵循标识符的命名规则,可以包含字母、数字和下划线,但不能以数字开头。
函数名应具有描述性,能够体现函数的功能。
【注释的命名规则】注释是程序员对代码的解释和说明,不会被编译器执行。
在 C 语言中,注释以“//”开头,可以包含任何字符。
注释的命名没有严格的规则,但为了保持代码的可读性,应使用简洁明了的语言。
【结束语】了解 C 语言的命名规则有助于编写出清晰、易于维护的代码。
C语言变量名命名规则一、程序风格:1、严格采用阶梯层次组织程序代码:各层次缩进的分格采用VC的缺省风格,即每层次缩进为4格,括号位于下一行。
要求相匹配的大括号在同一列,对继行则要求再缩进4格。
例如:2、提示信息字符串的位置在程序中需要给出的提示字符串,为了支持多种语言的开发,除了一些给调试用的临时信息外,其他所有的提示信息必须定义在资源中。
3、对变量的定义,尽量位于函数的开始位置。
二、命名规则:1、变量名的命名规则①、变量的命名规则要求用“匈牙利法则”。
即开头字母用变量的类型,其余部分用变量的英文意思或其英文意思的缩写,尽量避免用中文的拼音,要求单词的第一个字母应大写。
即:变量名=变量类型+变量的英文意思(或缩写)对非通用的变量,在定义时加入注释说明,变量定义尽量可能放在函数的开始处。
见下表:bool(BOOL) 用b开头bIsParentbyte(BYTE) 用by开头byFlagshort(int) 用n开头nStepCountlong(LONG) 用l开头lSumchar(CHAR) 用c开头cCountfloat(FLOAT) 用f开头fAvgdouble(DOUBLE) 用d开头dDetavoid(VOID) 用v开头vVariantunsigned int(WORD)用w开头wCountunsigned long(DWORD) 用dw开头dwBroadHANDLE(HINSTANCE)用h开头hHandleDWORD 用dw开头dwWordLPCSTR(LPCTSTR) 用str开头strString用0结尾的字符串用sz开头szFileName对未给出的变量类型要求提出并给出命名建议给技术委员会。
②、指针变量命名的基本原则为:对一重指针变量的基本原则为:“p”+变量类型前缀+命名如一个float*型应该表示为pfStat对多重指针变量的基本规则为:二重指针:“pp”+变量类型前缀+命名三重指针:“ppp”+变量类型前缀+命名......③、全局变量用g_开头,如一个全局的长型变量定义为g_lFailCount,即:变量名=g_+变量类型+变量的英文意思(或缩写)④、静态变量用s_开头,如一个静态的指针变量定义为s_plPerv_Inst,即:变量名=s_+变量类型+变量的英文意思(或缩写)⑤、成员变量用m_开头,如一个长型成员变量定义为m_lCount;即:变量名=m_+变量类型+变量的英文意思(或缩写)⑥、对枚举类型(enum)中的变量,要求用枚举变量或其缩写做前缀。
C语言命名规范10条第一篇:C语言命名规范10条C语言命名规范10条从事C语言的教学也有两年了,在教学中发现学生们在编程方面有一个极不好的习惯,就是随意命名,这不仅给自己日后阅读自己程序时带来不便,也给其他的程序阅读者带来麻烦,更重要的是没有统一的规范总显得像是个游击队,没有正规军的感觉,企业也不愿意要业余选手,所以C语言的初学者最好一开始就培养一种良好的编程习惯,也许日后进入公司有些改动,需要适应,但基本的规范和规则是不需要改的,这样可以帮助你少走很多弯路,经过这些年的学习和工作,总结了一些规范的内容,为了好记,便于传播,特总结为十条,建议读者采纳。
1)标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解。
程序中的英文单词一般不会太复杂,用词应当准确。
例如不要把CurrentValue写成NowValue。
2)不允许使用汉语拼音命名,更不要使用汉语,必须使用英文来命名标识符。
尽量避免名字中出现数字编号,如Value1,Value2等,除非逻辑上的确需要编号。
3)函数名、变量名从第二个单词起首字母大写。
如:printName(), oldName等4)在C 程序中只使用const常量而不使用宏常量,即const常量完全取代宏常量。
常量定义以大写字母K开头,字母全部使用大写,如:const int KSIZE = 100。
5)代码缩进使用4个空格,不推荐使用TAB键6)版权和版本的声明位于文件的开头;函数头部应进行注释,列出:函数的功能、输入参数、输出参数、返回值等。
关键代码注释位于被注释代码上方,且用空行与其他代码分割开,如:文件头注释:author: SDL teamfunction: testing hardware drivers and IDEdate: 2009.10copy right: Software College Of HeBei Normal University函数注释:function:SDL initialparameter: nonereturn: booltrue:initial SDL normallyfalse:initial SDL abnormally关键代码注释:pTemp = SDL_LoadBMP(aFileName);//format BMP file*aImg = SDL_DisplayFormat(pTemp);SDL_FreeSurface(pTemp);7)静态变量加前缀s_,如:staticints_count = 0;8)尽量避免应用全局变量,如果有特殊情况必须定义的话,全局变量以小写g_开头,如:intg_count = 0;9)结构体的名字开头字母要大写。
C语言命名规范是C语言编程中常见的一种规范,它着重于给编程中的变量、函数、常量、结构体等数据类型命名规范。
首先,C语言编程中的变量及其它数据类型的命名一般应该遵守驼峰命名法,比如numberOfPeople、numberOfCars等,而不是number_of_people、number_of_cars等;其次,C语言编程中的变量及其它数据类型的命名一般应该使用有意义的名称,比如使用lengthOfString来表示字符串的长度,而不是使用lenStr。
此外,C语言编程中定义的常量一般应该使用全部大写的字母,并且单词之间用下划线隔开,比如定义一个表示圆周率的常量PI,可以定义为PI_VALUE。
另外,C语言编程中定义的函数、结构体等应该遵守驼峰命名法,比如定义一个用来计算两个数字相加的函数,可以定义为addTwoNumbers,而不是add_two_numbers。
总之,C语言编程中应该遵守的命名规范是:变量及其它数据类型应该遵守驼峰命名法,使用有意义的名称;常量应该使用全部大写的字母,并且单词之间用下划线隔开;函数、结构体等应该遵守驼峰命名法。
这些规范的遵守有助于提高C语言编程的效率,提高程序的可读性。
C语言命名规则一、概述命名规则是编程语言中的重要组成部分,它决定了变量、函数、常量等标识符的命名方式。
在C语言中,良好的命名规则可以增加代码的可读性和可维护性,提高程序的质量和开发效率。
本文将详细介绍C语言中的命名规则,包括标识符的命名规范、命名风格和命名约定等方面。
二、标识符的命名规范在C语言中,标识符是用来表示变量、函数、常量等的名称。
标识符的命名规范如下:1. 字母和数字标识符由字母、数字和下划线组成,且必须以字母或下划线开头。
C语言区分大小写,因此大写字母和小写字母被视为不同的字符。
2. 长度限制标识符的长度通常不超过31个字符,超过部分会被截断。
尽管C语言标准没有规定具体的长度限制,但通常遵循这个约定可以提高代码的可读性。
3. 关键字和保留字C语言中有一些关键字和保留字被用于表示特定的语法和功能,这些单词不能用作标识符。
例如,“if”、“for”、“while”等都是C语言的关键字。
4. 规范命名标识符的命名应具有描述性,能够清晰地表达其含义。
一般来说,标识符应该是名词或名词短语,并且尽量避免使用缩写和简称。
例如,“studentName”比”stuName”更能表达变量的含义。
三、命名风格命名风格是指在给标识符命名时采用的具体方式和规范。
C语言中常见的命名风格有以下几种:1. 驼峰命名法驼峰命名法是将单词的首字母大写,并将多个单词连接起来,形成一个新的标识符。
例如,“studentName”是一个采用驼峰命名法的变量名。
2. 下划线命名法下划线命名法是将单词之间用下划线连接起来,形成一个新的标识符。
例如,“student_name”是一个采用下划线命名法的变量名。
3. 全部小写有些程序员习惯将标识符全部使用小写字母,以增加代码的可读性。
例如,“studentname”是一个采用全部小写命名风格的变量名。
4. 全部大写有些常量的命名习惯采用全部大写字母,并用下划线分隔单词。
例如,“MAX_SIZE”是一个采用全部大写命名风格的常量名。
COM接口协议协议名称:COM接口协议一、引言COM(Component Object Model)接口协议是一种用于组件之间通信和交互的标准。
本协议旨在定义COM接口的规范和约定,以确保不同组件之间的互操作性和兼容性。
该协议适用于COM组件的设计、开发、实现和使用。
二、术语定义1. COM组件:指符合COM接口规范的软件组件,具有独立的功能和逻辑,可以被其他组件调用和使用。
2. 接口:指COM组件对外提供的一组方法和属性,用于实现与其他组件的交互和通信。
3. 接口标识符(IID):用于唯一标识一个接口的GUID(Globally Unique Identifier)。
4. COM对象:指实现了一个或多个接口的COM组件的实例。
三、接口定义1. 接口命名规范a) 接口名称应具有描述性,清晰地表达其功能和用途。
b) 接口名称应以"I"开头,后跟具体的功能描述,采用驼峰命名法。
c) 示例:IExampleInterface2. 接口方法定义a) 方法名称应具有描述性,清晰地表达其功能和用途。
b) 方法名称应以大写字母开头,采用驼峰命名法。
c) 方法参数应明确指定类型和名称,避免使用缩写。
d) 方法返回值应明确指定类型,可以使用void表示无返回值。
e) 示例:```csharpvoid ExampleMethod(int parameter1, string parameter2);```3. 接口属性定义a) 属性名称应具有描述性,清晰地表达其功能和用途。
b) 属性名称应以大写字母开头,采用驼峰命名法。
c) 属性类型应明确指定,可以使用自定义类型。
d) 示例:```csharpstring ExampleProperty { get; set; }```四、接口实现1. COM对象的创建a) COM对象的创建应遵循COM规范,可以使用CoCreateInstance等方法。
b) COM对象的创建应提供明确的错误处理机制,以便通知调用方创建是否成功。
c命名规范C命名规范是指在编程中为变量、函数、类、常量等标识符取名的一套规则。
遵循良好的命名规范可以增加代码的可读性和可维护性,方便他人理解和使用代码。
一、命名原则1. 可读性原则:命名要具有可读性,方便其他人理解代码的含义。
避免使用缩写、不清晰的变量名或拼音命名,尽量使用有意义的单词或词组。
2. 一致性原则:命名应保持统一,遵循团队或项目的约定。
相同类型的标识符命名应统一,不同类型的标识符命名应区分开。
3. 易于搜索原则:命名要便于搜索和定位。
避免使用过长的命名,但也要避免使用过短的命名,使得标识符在项目中易于搜索和找到。
二、标识符的命名规范1. 变量和函数命名:使用小写字母和下划线,多个单词之间用下划线分隔。
例如:user_name, calculate_price。
2. 类的命名:使用驼峰命名法,即首字母大写,不使用下划线。
例如:UserInfo, CarFactory。
3. 常量的命名:使用大写字母和下划线,多个单词之间用下划线分隔。
例如:MAX_NUMBER, PI_VALUE。
4. 包名的命名:使用小写字母,多个单词之间使用点"."分隔。
例如:com.example.project。
5. 枚举类型的命名:使用大写字母和下划线,多个单词之间用下划线分隔。
例如:Color.RED, Season.SUMMER。
三、命名的约定1. 命名要有意义,尽量反映标识符的用途和含义,避免使用无意义的命名。
2. 避免使用保留字和关键字作为标识符,例如:int, float, if, else等。
3. 避免使用单个字母或数字作为标识符,除非是临时变量或索引变量。
4. 当命名较长时,可以使用缩写,但要确保缩写被广泛接受并易于理解。
5. 避免使用拼音命名,特别是在英文环境下,可能导致理解困难。
6. 命名要避免歧义和混淆,尽量不要使用相似的标识符,容易造成误解。
四、常见命名错误1. 不符合命名规范:命名不清晰、不规范,缺乏可读性和可维护性。
C#编码规范和编程好习惯命名惯例和规范注记:Pascal 大小写形式-所有单词第一个字母大写,其他字母小写。
Camel 大小写形式-除了第一个单词,所有单词第一个字母大写,其他字母小写。
类名使用Pascal 大小写形式方法使用Pascal 大小写形式变量和方法参数使用Camel 大小写形式不要使用匈牙利方法来命名变量以前,多数程序员喜欢把数据类型作为变量名的前缀,而m_作为成员变量的前缀。
例如:不好:然而,这种方式在.NET编码规范中是不推荐的。
VS是个智能的编程环境,它可以方便的提示变量的类型。
1、所有变量都应该用camel形式,而不用前缀。
好:2、用有意义的,描述性的词语来命名变量。
3、别用缩写。
编程中请使用用name, address, salary等代替 nam, addr, sal ,可以可读性更强。
VS 的智能提示功能可以方便的输入变量,不必想C语言那样为减少敲击键盘次数而使用缩写。
别使用单个字母的变量象i, n, x 等。
使用 index, temp等。
用于循环迭代的变量例外:如果变量只用于迭代计数,没有在循环的其他地方出现,一般使用单个字母的变量(i),而不是另外取名,这是一个约定俗成的习惯。
至少到现在为止,还没有发现这样做有什么不好。
5、变量名中不使用下划线 (_) ,成员变量除外。
在.net编程中,有时候为了区分局部变量和成员变量,会在成员变量前面加上(_),而且在重构的时候,VS也认可这种规则。
6、命名空间需按照标准的模式命名文件名要和类名匹配例如,对于类HelloWorld, 相应的文件名应为 helloworld.cs (或, helloworld.vb),尽量一个文件一个类缩进和间隔缩进用 TAB 不用 SPACES。
注释需和代码对齐。
花括弧 ( {} ) 需和括号外的代码对齐。
用一个空行来分开代码的逻辑分组。
在一个类中,各个方法需用一空行,也只能是一行分开。
花括弧需独立一行,而不象if, for 等可以跟括号在同一行。
Csharp命名规则说明1.1命名概述名称应该说明“什么”而不是“如何”。
通过避免使用公开基础实现(它们会发生改变)的名称,可以保留简化复杂性的抽象层。
例如,可以使用 GetNex tStud ent(),而不是 GetNex tArra yElem ent()。
命名原则是:选择正确名称时的困难可能表明需要进一步分析或定义项的目的。
使名称足够长以便有一定的意义,并且足够短以避免冗长。
唯一名称在编程上仅用于将各项区分开。
表现力强的名称是为了帮助人们阅读;因此,提供人们可以理解的名称是有意义的。
不过,请确保选择的名称符合适用语言的规则和标准。
以下几点是推荐的命名方法。
1、避免容易被主观解释的难懂的名称,如方面名 Analyz eThis(),或者属性名xxK8。
这样的名称会导致多义性。
2、在类属性的名称中包含类名是多余的,如 Book.BookTi tle。
而是应该使用Book.Title。
3、只要合适,在变量名的末尾或开头加计算限定符(Avg、Sum、Min、Max、Index)。
4、在变量名中使用互补对,如 min/max、begin/end 和 open/close。
5、布尔变量名应该包含 Is,这意味着 Yes/No 或 True/False值,如 fileIs Found。
6、在命名状态变量时,避免使用诸如 Flag 的术语。
状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。
不是使用 docume ntFla g,而是使用更具描述性的名称,如 docume ntFor matTy pe。
(此项只供参考)7、即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用有意义的名称。
仅对于短循环索引使用单字母变量名,如 i 或 j。
c命名规范C语言的命名规范是指在编写C语言程序时,为变量、函数、常量等标识符取名时应遵循的规范和约定。
一个良好的命名规范可以使程序的可读性更高,便于理解和维护。
下面是一些常见的C语言命名规范:1. 标识符的命名应具有描述性:标识符应该能够清楚地表达其所代表的意义,便于读者理解。
例如,变量名应该能够表述变量的用途和含义。
2. 使用小写字母:C语言是区分大小写的,为了避免混淆,一般采用小写字母来命名标识符。
3. 使用下划线命名法或驼峰命名法:C语言中常用的两种命名方式是下划线命名法(underscore naming)和驼峰命名法(camel case naming)。
下划线命名法指的是单词之间用下划线连接,例如:my_variable;驼峰命名法指的是第一个单词首字母小写,之后的每个单词首字母大写,例如:myVariable。
4. 避免使用特殊符号:C语言中的标识符不能包含特殊符号,如空格、点号、等号等,只能由字母、数字和下划线组成。
5. 选择具有意义的名字:标识符应该能够体现其所代表的含义。
避免使用无意义的缩写或简称,例如使用“i”代表索引值,使用“str”代表字符串等。
6. 遵循命名惯例:C语言有一些约定俗成的命名习惯。
例如,在宏定义中使用全部大写字母命名,并用下划线连接单词,例如:#define MAX_VALUE 100;结构体或联合体的命名应该以大写字母开头,例如:struct Student;常量的命名通常全大写,例如:const int MAX_SIZE = 10;函数的命名以小写字母开头,例如:void swap(int a, int b)。
7. 避免使用保留字:C语言中有一些保留字,用于表示语法结构或特殊功能,这些保留字不能用作标识符。
应避免使用保留字作为标识符,以免引起语法错误。
8. 选择简洁、清晰的名字:命名应该简洁明了,尽量避免过长的名字。
但同时也要保证名字足够清晰,尽量避免使用过于简单或模糊的名字。
c语言命名规则C语言是一种广泛应用于计算机编程的高级编程语言。
在C语言中,命名规则是非常重要的,因为它决定了程序的可读性和可维护性。
本文将介绍C语言命名规则的基本原则和最佳实践。
1. 命名规则的基本原则在C语言中,命名规则的基本原则是简洁、准确、易于理解和记忆。
以下是一些基本原则:1.1 使用有意义的名称变量、函数、结构体等的名称应该与它们所代表的实体有关。
例如,如果变量表示一个人的年龄,那么它的名称应该是age,而不是x或y。
1.2 使用小写字母在C语言中,大写字母和小写字母是不同的。
因此,为了避免混淆和错误,建议使用小写字母来命名变量、函数、结构体等。
1.3 使用下划线在C语言中,下划线(_)被广泛用于命名变量、函数、结构体等。
这是因为下划线可以使名称更易于阅读和理解。
例如,如果变量表示一个学生的年龄,那么它的名称应该是student_age,而不是studentage。
1.4 避免使用缩写为了避免混淆和错误,建议避免使用缩写。
如果必须使用缩写,应该确保它们是广泛使用和广为人知的。
例如,HTTP是一个广为人知的缩写,但是不是所有人都知道TTL(Time to Live)是什么意思。
1.5 避免使用保留字在C语言中,有一些特殊的单词称为保留字。
这些单词具有特殊的含义,不能用作变量、函数、结构体等的名称。
因此,建议避免使用保留字作为名称。
2. 命名规则的最佳实践除了基本原则之外,以下是一些最佳实践,可以帮助您更好地命名变量、函数、结构体等。
2.1 使用驼峰命名法驼峰命名法是一种常用的命名规则,它可以使名称更易于阅读和理解。
在驼峰命名法中,每个单词的首字母大写,除了第一个单词的首字母。
例如,studentAge。
2.2 使用有意义的前缀有时候,为了区分不同类型的变量、函数、结构体等,可以使用有意义的前缀。
例如,变量student_age和函数student_get_age就可以使用student作为前缀。
C语言命名规则详解C语言是一种广泛使用的编程语言,它有自己的命名规则,用来给变量、函数、类型、常量等标识符起名字。
命名规则的目的是让代码更加清晰、易读、统一和规范。
本文介绍了C语言中常见的四种命名法则:驼峰命名法、匈牙利命名法、帕斯卡命名法和下划线命名法,以及它们的优缺点和适用场合。
本文还介绍了一些通用的命名原则和建议,以及不同类型的标识符的命名规范和示例。
本文尽量使用表格来对比和总结不同的命名法则和规范,方便读者理解和记忆。
1. 常见的命名法则在C语言中,有四种比较流行的命名法则:驼峰命名法、匈牙利命名法、帕斯卡命名法和下划线命名法。
它们的特点和区别如下表所示:命名法则特点优点缺点适用场合驼峰命名法以小写字母开头,每个单词首字母大写,不含下划线简洁,节省空间不够明显,容易混淆变量、函数匈牙利命名法以类型或作用域为前缀,每个单词首字母大写,不含下划线明确,易于区分冗长,复杂变量、函数帕斯卡命名法以大写字母开头,每个单词首字母大写,不含下划线规范,一致不够灵活,容易冲突类型、常量下划线命名法全部小写,单词之间用下划线连接清晰,易读占用空间,不美观变量、函数2. 通用的命名原则除了遵循上述的命名法则外,还有一些通用的原则和建议可以帮助我们更好地给标识符起名字:标识符的名称应该有明确的含义,反映其作用和功能,避免使用无意义或歧义的名称。
标识符的名称应该尽量简洁而完整,避免过长或过短。
过长的名称会占用空间和时间,过短的名称会缺乏信息和可读性。
标识符的名称应该使用英文单词或常用的缩写,避免使用中文拼音或其他语言。
如果使用缩写,应该保证其能被广泛理解和接受。
标识符的名称应该区分大小写,并且保持一致。
不同类型的标识符可以采用不同的大小写风格,但同一类型的标识符应该遵循同一种风格。
标识符的名称应该避免与C语言的关键字和保留字冲突或混淆。
如果不得已使用关键字或保留字,应该加上前缀或后缀来区分。
标识符的名称应该根据其作用域和可见性来命名。
C#编码命名规则1.基本规则第一个字母必须大写,并且后面的并发连结词的第一个字母均为大写例:GeneralManager、SmallDictionary、StringUtil2.接口命名规则接口名称前加“I”interface ICompare{int compare();}类的命名类名添加cls前缀public class clsTextBox{public void DataBind(){}}WebServer的命名类名添加ws前缀public class wsTextBox{public void DataBind(){}}方法、属性的命名使用Pascal大小写形式,一般将其命名为动宾短语.ShowDialog()CreateFile()变量、参数使用Camel 大小写形式例:int totalCount常量全部大写,单词之间以“_”分隔例:USER_PASSWORD代码的缩进用Tab,而不要用space其他代码命名规则1.局部变量的名称要有意义.不要用x,y,z等等(循环变量除外)2.所有的成员变量声明在类的顶端,用一个换行把它和方法分开3.文件名要能反应类的内容,最好是和类同名,一个文件中一个类.4.大括号"{"要新起一行.public class AuthorAttribute : Attribute{}5. switch语句一定要有default来处理意外情况6. 同程序外部连接(数据库、接口、文件等)一定要捕获任何类型的异常(try)给出友好的消息给用户,必要时用日志记录错误的细节,包括发生的时间,和相关方法,类名等。
不要“捕捉了异常却什么也不做”7. 始终使用"{ }"包含if/else下的语句,即使只有一条语句8. 把引用的系统的namespace和自定义或第三方的分开9. 自定义的属性以Attribute结尾public class AuthorAttribute : Attribute{}10.自定义的异常以Exception结尾public class AppException : Exception{}11.注释需和代码对齐12.用一个空行来分开代码的逻辑分组13.花括弧( {} ) 需和括号外的代码对齐14.不在代码中使用具体的路径和驱动器名,使用相对路径,并使路径可编程数据库命名规则15. 表:e—业务表中相对独立的实体表(例如:课程资源表……)r—业务中产生的关联表(例如:选课表……)b—系统中的基本表(例如:类型表、民族、地区……)16. 视图:v_<ViewName> 首字母大写17. 存储过程:sp_<SpName> 首字母大写18. 触发器:t _<TriggerName> 首字母大写19. 函数过程:fn_<FunctionName> 首字母大写20.列名:一般第一列名为ID、主键、标识递增其他列名尽可能用英文单词或英文缩写,如英文过长(超过6位)或过于生僻可用汉语拼音的首字母。
Csharp命名规则说明1.1命名概述名称应该说明“什么”而不是“如何”。
通过避免使用公开基础实现(它们会发生改变)的名称,可以保留简化复杂性的抽象层。
例如,可以使用 GetNextStudent(),而不是 GetNextArrayElement()。
命名原则是:选择正确名称时的困难可能表明需要进一步分析或定义项的目的。
使名称足够长以便有一定的意义,并且足够短以避免冗长。
唯一名称在编程上仅用于将各项区分开。
表现力强的名称是为了帮助人们阅读;因此,提供人们可以理解的名称是有意义的。
不过,请确保选择的名称符合适用语言的规则和标准。
以下几点是推荐的命名方法。
1、避免容易被主观解释的难懂的名称,如方面名 AnalyzeThis(),或者属性名 xxK8。
这样的名称会导致多义性。
2、在类属性的名称中包含类名是多余的,如 Book.BookTitle。
而是应该使用 Book.Title。
3、只要合适,在变量名的末尾或开头加计算限定符(Avg、Sum、Min、Max、Index)。
4、在变量名中使用互补对,如 min/max、begin/end 和 open/close。
5、布尔变量名应该包含 Is,这意味着 Yes/No 或 True/False 值,如 fileIsFound。
6、在命名状态变量时,避免使用诸如 Flag 的术语。
状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。
不是使用 documentFlag,而是使用更具描述性的名称,如 documentFormatType。
(此项只供参考)7、即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用有意义的名称。
仅对于短循环索引使用单字母变量名,如 i 或 j。
可能的情况下,尽量不要使用原义数字或原义字符串,如For i = 1 To 7。
而是使用命名常数,如 For i = 1 To NUM_DAYS_IN_WEEK 以便于维护和理解。
C# 编码规范(参考微软规范)原创作者周志宁1.名称空间规范1.1多配件/解决方案项目必须包含名称空间1.2不同类别/功能/组件的文件不应当放在同一个项目目录,应当建立目录存放1.3存放在目录内的名称空间应当与目录名一致例如:A 系统为汽车相关系统,/……根目录存放程序入口主体对象对象名称空间为CarFrameWork/Engine/……引擎目录,存放车辆引擎构造名称空间为CarFrameWork.Engine/Direction/……车辆转向系统构造名称空间为CarFrameWork.Direction2.类/接口规范2.1类的命名只能采用英文名词,禁用汉语拼音作为类名2.2类名中每个单词首字母大写,缩写全部大写,其余字母小写例如public class CarFactory 是正确的Public class carFactory 或者Carfactory 都是错误的2.3可以使用常用缩写,如缩写非常用缩写,建议写全称。
例如UserInterface 可以缩写成UI例如CarFactory 不应当缩写为CarFac2.4不应当在类名命名中使用“_”。
2.5接口(interface)开头以大写字母”I”开头,抽象类以”Abstract”开头,非接口类型尽量避免以大写字母”I”开头。
2.6类名应当与文件名保持一致2.7设计中如果采用了设计模式,应当以明确的设计模式名称加在命名结尾处例如:DataBaseAdapter 表明该类是一个适配器例如: DataBaseFactory 表明该类是一个数据库工厂例如: DataBaseAbstractFactory表明该类是一个抽象数据库工厂2.8 类的使用应当遵循功能单一原则,严禁在一个类中实现一个全部流程3.方法规范3.1使用动词或者动词短语对方法进行命名,严禁使用汉语拼音.3.2 类名中每个单词首字母大写,缩写全部大写,其余字母小写3.3 使用有意义的单词进行命名,单词尽量为常用英语单词,如果单词长度超过10个字母,应当考虑使用更简短的单词替换3.4 资源使用3.4.1 有限资源(数据库/IO/SOCKET/队列等)使用必须使用try catch捕捉错误3.4.2 有限资源使用结束后必须使用手动释放,释放代码应当放在finally中3.4.3 多线程程序在使用资源后,应当及时释放,任务完成后挂起或者终止子线程,并手动回收垃圾3.5 方法的入口变量命名尽可能保持无歧义,大小写规则与类的规则相同3.6 构造函数入口参数变量名避免与内部函数同名4.成员变量命名规范4.1成员变量命名规范4.1.1 与作用域外不发生任何关系的变量不应当声明为public,也不应当在变量前加上private修饰。
命名规范_C(Sharp)
1.命名规范
a)类
【规则1-1】使用Pascal规则命名类名,即首字母要大写。
【规则1-2】使用能够反映类功能的名词或名词短语命名类。
【规则1-3】不要使用“I”、“C”、“_”等特定含义前缀。
【规则1-4】自定义异常类应以Exception结尾。
【规则1-5】文件名要能反映类的内容,最好是和类同名。
b)类字段
【规则2-1】用camel规则来命名类成员变量名称,即首单词(或单词缩写)小写。
【规则2-2】类字段变量名前可加“_”前缀。
【规则2-3】坚决禁止在普通变量前加“m_”(这是VC老命名规则)。
c)方法
【规则3-1】方法名采用Pascal规则,第一个字符要大写。
【规则3-2】方法名应使用动词或动词短语。
【规则3-3】类中访问修饰符或功能相同的方法应该放在一起,且公共或实现接口的方法在前。
d)属性
【规则4-1】使用名词定义属性,属性使用Pascal规则,首字符大写。
【规则4-2】属性和相应字段名称要关联,可以使用“重构”菜单来生成属性。
e)参数
【规则5-1】参数采用camel规则命名,且首字符小写。
【规则5-2】使用描述性参数名称,参数名称应当具有最够的说明性。
【规则5-3】不要给参数加匈牙利语类型表示法的前缀。
【规则5-4】检查方法所有输入参数的有效性。
f)常量
【规则6-1】只读常量使用Pascal命名规则,即首字母大写。
【规则6-2】枚举名使用Pascal规则命名,枚举成员本质属于常量,命名规则同上。
【规则6-3】枚举值从小到大顺序定义。
【规则6-4】静态字段或属性采用Pascal规则,即首字符大写。
g)接口
【规则7-1】接口定义使用Pascal规则,且必须以大写“I”开头。
【规则7-2】接口名称要有意义,中间不要有下划线“_”等字符。
【规则7-3】如果类实现了接口,名称尽量和接口相同,只是省掉“I”
字符。
h)事件
【规则8-1】委托名称采用Pascal规则,即首字符大写。
【规则8-2】定义事件的委托要使用EventHandler后缀,且包括sender 和e两个参数。
【规则8-3】事件用到的参数类,名称要带EventArgs后缀。
i)命名空间
【规则9-1】命名空间名称采用Pascal规则,且首字符大写。
【规则9-2】命名空间名称尽量反映其内容所提供的整体功能。
2.注释规范
a)文件头部注释
【规则1-1】文件都包含文件头,要说明文件名、作者、创建时间、变更记录。
【规则1-2】推荐采用.NET形式书写头部注释。
b)类及其成员注释
【规则2-1】对方法和类使用“///”三斜线注释。
【规则2-2】代码行文注释采用“//”和“/**/”进行,应该尽量说明问题。
3.行文规范
a)缩写规范
【规则1-1】标识符应当直观可望文知意,不提倡使用任何缩写。
【规则1-2】字符串变量推荐是用“str”或“s”开头,采用string.Empty 来初始化。
【规则1-3】普通对象可以以“obj”开头。
【规则1-4】缩写可自行定义,一般取单词的前/后字符组成,以含义直观为准则。
【规则1-5】一般情况下不要让缩写破坏标识符的含义。
b)排版
【规则2-1】每行语句至少占一行,如果语句过长(超过一屏),则该语句断为两行显示。
【规则2-2】把相似的内容放在一起,比如字段、属性、方法、事件等,使用“#region--#endregion”命令分组。
【规则2-3】多个程序元素进行对等操作是,操作符之前、之后或者前
后都要加空格。
【规则2-4】每个方法的源程序行数原则上应该少于200行。
【规则2-5】语句嵌套层次不得超过3层。
【规则2-6】避免相同的代码段在多个地方出现。
c)语句结构
【规则3-1】如果使用了异常结构,一定要处理异常,一般是要写日志文件。
【规则3-2】分支语句不应该使用复杂长条件,应该将长条件封装成方法。
【规则3-3】switch语句,case后面必须接break。
【规则3-4】禁止使用goto语句进行跳转。
【规则3-5】行文中严禁出现“魔数”,特定含义的常数必须定义成枚举或常量。
【规则3-6】不同类型的操作符混合使用时,使用括号给出优先级。
【规则3-7】不允许使用复杂的操作符组合等。
【规则3-8】循环、判断语句的程序块部分用花括号括起来,即使只有一条语句。
【规则3-9】在switch语句中总是要有default字句,建议使用断言。
【规则3-10】每个类和方法完成单一的功能,不设计多用途面面俱到的类或方法。
【规则3-11】严禁使用未经初始化的变量,变量通常使用构造方法来初始。
d)代码缩进
【规则4-1】碰到大括号要换行。
【规则4-2】不允许使用Java中的括号换行规范。
e)大小写
【规则5-1】不要创建名称相同,但大小写区别的任何元素。
【规则5-2】应当大写仅有两个字符的缩写。
【规则5-3】不要把易混淆的数字和字符放在一起。
【规则5-4】使用英文命名标识符。
f)重名规范
【规则6-1】不允许变量名、类名、属性名、方法名等与系统标识符重名。
(系统标识符见附表)
g)SQL编码规范
【规则7-1】SQL语句全部大写。
【规则7-2】对较为复杂的SQL语句加上注释,说明其功能。
【规则7-3】连接符OR、IN、AND、以及=、<=、>=等前后加空格。
【规则7-4】使用明确的列代替SELECT*。
h)软件架构
【规则8-1】数据库中每一张表对应一个实体类/数据传输对象(DTO)。
【规则8-2】实体类名称使用表名,也可带有Dto后缀。
【规则8-3】三层架构应当合理使用,不应生搬硬套。
【规则8-4】三层架构元素推荐使用后缀:
数据传输对象XxxxDto
DAO工厂XxxDAOFactory
DAO接口IXxxxDAO
服务接口IxxxxService
DAO的数据库实现XxxxDAOOracle/XxxxDAOInfomix
业务逻辑XxxxManager
i)系统
【规则9-1】在国内不要随便使用设计模式等代码模式,因为并不流行。
【规则9-2】系统输入、资源操作(如内存分配、文件及目录操作)、网络操作(如通信、调用等)、任务间的操作(如通信、调用等)时必须进行错误、超时、或则异常处理。
【规则9-3】模块编写应该有完善的测试方面的考虑。
附表
表1各种类型命名规范总结
表2数据类型缩写规则
表3Windows控件缩写规则
表4数据库对象缩写规范。