代码编写规范v1.2
软件工程软件代码编程规范

软件代码编程规范软件代码编程规范编号:发布日期:编制部门:研发部审核人:批准人:目录0.版本记录 (5)1.目的 (6)2.适用范围 (6)3.术语定义 (6)3.1 原则 (6)3.2 规则 (6)3.3 建议 (6)3.4 说明 (6)3.5 正例 (6)3.6 反例 (7)4.职责 (7)5.工作程序 (7)5.1 基本原则 (7)5.1.1 原则1-1 (7)5.1.2 原则1-2 (7)5.1.3 原则1-3 (7)5.1.4 原则1-4 (7)5.1.5 原则1-5 (7)5.1.6 原则1-6 (8)5.1.7 原则1-7 (8)5.2 布局 (8)5.2.1 基本格式 (8)5.2.2 对齐 (10)5.2.3 空行空格 (12)5.2.4 断行 (14)5.3 注释 (15)5.3.1 规则3-1 (15)5.3.3 规则3-3 (16)5.3.4 规则3-4 (16)5.3.5 规则3-5 (17)5.3.6 规则3-6 (17)5.3.7 规则3-7 (18)5.3.8 规则3-8 (18)5.3.9 规则3-9 (19)5.3.10 规则3-10 (20)5.3.11 建议3-1 (20)5.3.12 建议3-2 (20)5.4 命名规则 (20)5.4.1 规则4-1 (21)5.4.2 规则4-2 (21)5.4.3 规则4-3 (21)5.4.4 规则4-4 (23)5.4.5 规则4-5 (23)5.4.6 规则4-6 (23)5.4.7 规则4-7 (23)5.4.8 规则4-8 (23)5.4.9 规则4-9 (24)5.4.10 规则4-10 (24)5.4.11 规则4-11 (25)5.4.12 规则4-12 (25)5.4.13 规则4-13 (25)5.4.14 规则4-14 (25)5.4.15 规则4-15 (26)5.4.16 规则4-16 (26)5.4.17 规则4-17 (26)5.4.19 规则4-19 (27)5.4.20 建议4-1 (27)5.4.21 建议4-2 (27)5.5 声明 (27)5.5.1 规则5-1 (27)5.5.2 规则5-2 (27)5.5.3 建议5-1 (27)5.6 表达式与语句 (28)5.6.1 规则6-1 (28)5.6.2 规则6-2 (29)5.6.3 规则6-3 (29)5.6.4 规则6-4 (29)5.6.5 规则6-5 (30)5.6.6 规则6-6 (30)5.6.7 建议6-1 (30)5.6.8 建议6-2 (30)5.6.9 建议6-3 (31)5.6.10 建议6-4 (31)5.6.11 建议6-5 (32)5.7 类和接口 (33)5.7.1 规则7-1 (33)5.7.2 建议7-1 (34)5.7.3 建议7-2 (34)5.7.4 建议7-3 (34)5.7.5 建议7-4 (34)5.7.6 建议7-5 (35)5.7.7 建议7-6 (35)6.相关文件 (35)0.版本记录以C#代码为例,规范编码规则和注意事项,明确编程的各项要求,提高代码的可靠性、可读性、可修改性、可维护性、一致性、可再利用性等。
人民银行征信系统贷款数据上报--数据采集格式V1.2

第一章目录第一部分数据采集格式V1. 21第三部分数据校验规则V1. 229第四部分上报数据反馈格式V1. 242第五部分账户标识报文格式V1.052第六部分数据删除格式V1. 256第七部分错误数据更正指南V1. 262个人信用信息基础数据库数据接口规范第一部分:信贷数据采集格式(V1.2)目录1 范围 (1)2 规范性引用文件 (1)3 术语和定义 (1)4 要求 (2)4.1 数据类型定义 (2)4.2 标识项定义 (3)4.3 数据处理规则 (3)4.4 数据文件传送方式 (3)4.5 数据报送文件的命名规则 (3)4.6 加密 (4)5 个人信用信息基础数据库数据采集指标体系 (4)5.1 个人信用信息基础数据库采集信息分类 (4)5.2 个人信用信息基础数据库采集指标 (5)6 个人信用信息基础数据库数据采集报文的结构 (9)7 个人信用信息基础数据库数据项信息采集模型与采集数据项 (10)7.1 个人信用信息基础数据库数据项信息采集模型 (10)7.2 个人信用信息基础数据库采集数据项 (11)附录 A (规范性附录)个人信用信息基础数据库数据元目录 (1)A.1 数据元的表示格式 (1)A.2 数据元的分类 (1)A.3 数据元目录 (1)A.3.1 与金额、利率、比率等有关的数据元 (1)A.3.2 与日期、时间、期限有关的数据元 (5)A.3.3 与地点、地址、通信联系有关的数据元 (7)A.3.4 与数量(非货币量)、计量单位等有关的数据元 (9)A.3.5 与人的基本物理信息和社会信息有关的数据元 (11)A.3.6 与机构的基本特征有关的数据元 (14)A.3.7 与银行业务基本属性有关的数据元 (14)A.3.8 其他数据元 (16)附录 B (规范性附录)个人信用信息基础数据库代码集 (19)B.1 索引 (19)B.2 代码表的编写格式 (19)B.2.1 代码表的编排格式 (19)B.2.2 代码值的类型及表示格式 (19)B.3 代码表 (20)个人信用信息基础数据库数据接口规范第一部分:信贷数据采集格式(V1.2)1 范围本规范规定了个人信用信息基础数据库数据采集指标体系、数据采集报文的结构、数据项信息采集模型,以及数据采集中对数据处理的要求。
Xiuno编码规范

Xiuno 全栈工程师编码规范版本:v1.0作者:****************时间:2015/3/20 一、PHP 编码规范与原则前言:本文档是一本面向全栈工程师的编码规范,如果你想成长为全栈式工程师,我相信这个规范是你成功的起点。
总体说来倾向于linux 系统编程的风格,nginx memcached mysql lighttpd 都是采用的小写加下划线的命名风格。
而Windows Java .net 采用的则是匈牙利和骆驼,没有谁好谁坏,习惯就好。
1.1 缩进:每个TAB 键缩进的空白为8 个空格字符宽度。
好处:尽量避免代码缩进,强迫在编写过程中简化逻辑。
1.2 空行与空格:大段代码应该尽量按照功能块用一个空行分割。
函数和函数之间应该有一个空行。
空行内不能包含空格或制表符。
HTML 中不允许出现连续1个以上的空格。
在提示信息或者文档中中文、英文、数字混排的时候,英文和数组应该前后加空格。
1.3 括号:if 紧跟小括号,小括号与大括号之间一个空格,开始大括号与if 同行。
如果业务逻辑简单,尽量使用AND 操作符,优先级比&& 低。
以下代码格式符合标准:if($method == 'GET') {$referer = user_http_referer();$title = $lang['user_create'];include './view/user_create.htm';} else if($method == 'POST') {$email = param('email');$password = param('password');empty($password) AND message(1, “请输入密码!”);}1.3 单引号、双引号在PHP 当中,尽量使用单引号,解析速度比双引号快。
编码规范——精选推荐

编码规范编码规范整理初稿1命名规范1.1顶层⽂件命名规范级别: 规定说明: 采⽤芯⽚型号名+top的命名⽅式⽰例:xxxx_top.v1.2⼦系统顶层命名规范级别: 规定说明: 采⽤⼦系统缩写+top的命名⽅式⽰例:xxxx_top.v1.3存储器模块命名规范级别: 规定说明: RAM存储器模块的⽂件命名采⽤下⾯的形式:时钟类型_Ram类型_深度x位宽[w_深度x位宽r][_reg].v时钟类型:读写时钟同步⽤com,异步⽤diffRam类型:对于双⼝ram为dpram,对于单端⼝ram为ram,对于单端⼝rom为rom,对于FIFO为fifo,对于移位寄存器为shift;_深度x位宽:⽤于描述写端⼝的位宽以及该位宽对应的深度;[w_深度x位宽r]:可选字段,⽤于描述读端⼝的位宽以及该位宽度对应的深度,若存储器读写端⼝位宽⼀致,或存储器只读,该字段可省略;[_reg]:可选字段,采⽤寄存器输出的使⽤需要以_reg为结尾进⾏标⽰,输出不采⽤寄存器输出的则不使⽤.⽰例:1.4模块命名规范其他约束级别: 规定说明: ⼀个设计⽂件只包含⼀个模块,为了⽅便阅读查找,⽂件名应与⾥⾯的模块(module)名相同⽰例:1.5⽂件名应由字母、数字及下划线组成,⾸字符应为字母级别: 规定说明: 命名只能由26个英⽂字母(a-z,A-Z)、数字(0-9)或者下划线( _ )组成。
不允许使⽤破折号和连续的下划线。
第⼀个字符只能使⽤字母,不能使⽤下划线。
⽰例:1.6信号名使⽤有意义的名字,不宜超过32个字符级别: 规定说明: ⽂件名和信号名应尽量做到望⽂⽣义,⾔简意赅,同时不宜超过32个字符。
⽰例:1.7⽤下划线分开多个单词级别: 规定说明: 由多个字符串组成的⽂件名或者信号名,每个字之间要⽤下划线分开说明:可读性⽰例:1.8常量应⽤⼤写字母表⽰,推荐以“C_”打头级别: 规定说明: 常量应⼤写。
包括参量(parameter)名、⽂本宏名都要⼤写说明:提⾼可读性⽰例:1.9模块内部的信号以“S_”打头,其他字母建议⼩写级别: 规定说明: 对内部定义的信号,命名以”S_”打头,其他字母⼩写。
ATAQQ即时通讯系统编码规范

ATAQQ即时通讯系统编码规范Version1.0目录1. 规范目标 (3)2.具体注意事项 (3)2.1、命名原则 (3)2.2、变量的命名 (3)2.3、函数的命名 (3)2.4、类命名 (3)2.5、控件命名规则 (4)2.6、文件命名 (4)2.7、参数的命名 (5)3. 代码格式书写规范 (5)3.1、代码书写格式 (5)3.2、注释的写法 (6)3.3、其他 (7)4. 代码组织 (7)5. 调试技巧 (8)5.1 编译时的错误 (8)5.2 运行时的错误 (8)5.3 C#常见问题 (8)附录 (9)1. 规范目标(1)安全代码完成所需的功能之余,还要增加开发过程代码的强壮性,即要稳定可靠。
(2)易读类,实例,成员变量,成员函数的命名一目了然(3)美观尽量统一项目组内人员的编程风格,保证一致性,统一性。
2.具体注意事项2.1、命名原则(1)所有的函数(变量/类/文件名)应该代表其实际的作用。
应该使用具有意义的单词或多个词组合,但不要使用人名,项目组名。
(2)所有的函数(变量/类名)一律使用英文。
(3)使用多个单词时不需要使用连线(如下划线)(4)多个词组合较长时,可以使用单词的缩写。
(5)不得使用非常相近的名字类表示几个不同含义的函数(变量/类)。
(6)命名时请考虑名字的唯一性和含义的准确性。
(7)命名采用三种格式,Pascal(大小写),Camel(大小写混合),首字母全部大写格式如:Id 2.2、变量的命名(1)变量名一般由"前缀+类型修饰+代表变量含意的英文单词或单词缩写"等部分组成。
如:*前缀(以下划线分割):t_:表示线程的全局变量。
如:t_nCountm_:表示类成员变量(包含类表态变量)如:m_dwFlags_ 局部变量以”_”开头,如 _userName*主体使用一个或多个单词表示变量代表的确切含义,参见下面的大小写规则。
*类型修饰(小写字母):n l s u f b by ch sz str douint long short uint float bool byte char char[] String double (2)针对异常捕获过程中的Exception变量命名,在没有冲突的情况下,统一命名为 e;2.3、函数的命名(1)使用动宾词组表达函数所做的事。
文件编写规范

文件编写规范1 目的规范和统一公司质量、环境及职业健康安全整合管理体系(以下简称“整合管理体系”)文件的编写格式。
2 范围适用于公司整合管理体系有关文件和记录的编写、文件版面设置、文字打印输出。
3 职责3.1 运营管理部负责本规定的制订和修改。
3.2 各部门按本文件规定的格式、编写方法和文字打印输出要求,拟订整合管理体系有关文件。
4 编写规范4.1 文件版号、颁布日期、实施日期、页码的确定4.1.1制度、规范(作业指导书)版本号以“V×.×”表示,文件首次生效的版本号为“V1.0”,每次修订后版本由V1.0依次变为V1.1、V1.2……标准换版或文件修订5次以上,版本依次升级为V2.0、V3.0……版本号的更改按照《文件控制程序》的要求进行。
4.1.2表单版本号以“×/×”表示,文件首次生效的版本号为“A/0”,每次修订后版本由A/0依次变为A/1、A/2……标准换版或文件修订5次以上,版本依次升级为B/0、B/1……版本号的更改按照《文件控制程序》的要求进行。
4.1.3 “颁布日期”为文件最新版本批准发布的日期。
4.1.4“实施日期”为文件施行的日期。
4.2 文件版面格式4.2.1管理制度正文编写的格式和内容包括:✓目的✓范围✓定义(如果有必要的话)✓职责✓工作程序或内容✓相关文件✓记录4.2.2 作业指导书等其它管理性文件、技术文件、公开文件正文的编写格式和内容包括:✓目的✓适用范围✓工作指导✓相关文件✓记录4.3 文件打印输出要求4.3.1文件打印输出统一使用A4纸张,记录建议使用A4、A3等标准尺寸纸张。
文件的编辑排版使用Microsoft Word软件。
4.3.2正文采用小四号字,其中中文和数字采用仿宋字体,字符间距采用“标准”,行间距为“1.5倍行距”,采用左端对齐方式对齐。
4.3.3正文中一级标题采用仿宋字体,编号采用阿拉伯数字;其余文字采用常规字形,项目编号采用1, 2, 3,...,一级标题与上节内容间空一行。
编码规范要求

编码规范要求篇一:编码规范中中实智达开发规范文档修改记录1、概述1、1 目的在软件的生命周期中,维护的花费通常占很大的比例,且几乎所有的软件,在其整个生命周期中,开发人员和维护人员都不尽相同。
编码规范可以改善软件的可读性,使程序员尽快而彻底地理解代码;同时,编码规范还可以提高程序代码的安全性和可维护性,提高软件开发的生产效率,所以,编码规范对于程序员而言至关重要。
为使开发项目中所有的 JAVA程序代码的风格保持一致,增加代码的可读性,便于维护及内部交流,使 JAVA程序开发人员养成良好的编码习惯,有必要对 JAVA程序的代码编码风格做统一的规范约束。
本文档定义了我公司软件开发过程中使用的开发语言的编码规范,指导软件开发人员在进行项目开发过程中提高代码质量、统一编码要求。
1.2适用范围除客户方另有特别要求外,适用于 JAVA、JSP、Servlet等项目的开发。
2、JAVA源文件2.1、PACKAGEPackage是组织相关类的一种比较方便的方法。
Package使我们能够容易查找和使用类文件,并可以帮助我们在运行程序时更好的访问和控制类数据。
类文件可以很容易的组织到 Package中,只要把相关的类文件存放到同一个目录下,给该目录取一个与这些类文件的作用相关的名称。
如果需要声明程序包,那么每个 JAVA文件(*.java)都需要在顶部进行 Package的声明,以反映出包的名称。
例:package .meritit.product.modul.dao;2.2 JAVA源文件的内部结构2.2.1 Package/ImportPackage行要在 import行之前,import中标准的包名要在本地的包名之前。
如果 import行中包含了同一个包中的不同子目录,应import到某一个指定的类,避免*类型的 import。
(导包:Ctrl+Alt+O)例:package .meritit.product.modul.dao;import java.io.*;(不提倡,应该避免)import java.io.InputStream;import java.io.OutputStream;2.2.2Class所有的 JAVA(*.java)文件都应遵守如下的样式规则,如果JAVA源文件中出现以下相应的部分,应遵循如下的先后顺序。
(完整)C++编码规范

1。
命名规则1.1. 起个合适的名字1。
1.1。
类的名称(适用于C++)²类的名称要能告诉我们,这个类是什么。
因此,类的名称通常是名词.²类的名字不需要告诉我们,它从哪个类继承而来的。
²有时候加个后缀是很有用的。
比如类是一个代理(Agents)时,起名叫DownloadAgent更能表达真实的意图。
1。
1.2。
方法和函数的名称(适用于C/C++)²方法和函数通常都要执行某种行为,因此,名称要能清楚的说明它做什么:CheckForErrors() 而不是ErrorCheck(),DumpDataToFile()而不是 DataFile()。
这样也可以很容易的区别函数和数据。
²函数名总以动词开头,后面跟随其它名称。
这样看起来更自然些。
²可以加一些必要的后缀:Max –表示取最大值Cnt –表示当前的计数值Key –表示键值例如:RetryMax 表示可接收的最大数,RetryCnt表示当前接收的数量.²前缀也同样有用:Is –用于询问一些问题。
只要看到Is开头,就知道这是一个查询.Get –用于获取一个值。
Set –用于设置一个值。
例如:IsHitRetryLimit.1。
1。
3。
含有度量单位的名称(适用于C/C++)²如果一个变量用于表示时间,重量或其它度量单位,应把度量单位添加到名称中,以便开发人员更早一步发现问题。
例如:uint32 mTimeoutMsecs;uint32 mMyWeightLbs;1.1。
4. 缩写名称不要全部大写(适用于C/C++)²无论是什么缩写名称,我们总以一个大写字母开头,后面跟随的字母全部用小写。
例如:class FluidOz; // 而不是 FluidOZclass NetworkAbcKey;// 而不是 NetworkABCKey1.2.类的命名(适用于C++)²用大写字母作为单词的分隔,每个单词的首字母大写,其它字母均小写。
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
代码编写规范一概述 (3)二源代码编写规范内容 (3)1.文件和目录 (3)2.命名规范 (4)2.1窗体(v1.2版本中修订的) (4)2.2父窗体(v1.2版本中修订的) (4)2.3页面(v1.2版本中修订的) (5)2.4类名(类文件名) (5)2.5类模块名:常用于VB开发中 (5)2.6模块名:常用于VB开发中 (6)2.7函数名(过程名) (6)2.8变量名 (6)2.9对象名:同变量命名 (7)2.10控件名:同变量命名 (7)3.注释规范 (7)3.1有效注释量 (7)3.2说明性文件 (7)3.3源文件头 (7)3.4函数头部说明 (8)3.5注释与代码一致 (9)3.6注释内容 (9)3.7注释缩写 (9)3.8注释位置 (9)3.9变量、常量注释 (10)3.10数据结构的注释 (10)3.11全局变量 (11)3.12注释缩排 (11)3.13注释与代码之间空行 (12)3.14变量定义、分支语句 (12)3.15其他 (13)4.代码书写格式 (14)4.1空行 (14)4.2代码行 (15)4.3代码行内的空格 (16)4.4对齐 (17)4.5长行拆分 (19)4.6修饰符的位置 (19)4.7函数与类 (20)4.8消息框使用 (21)5.常用语法说明 (22)5.1运算符的优先级 (22)5.2复合表达式 (23)5.3 if 语句 (23)5.4循环语句的效率 (24)5.5 for 语句的循环控制变量 (25)5.6 switch语句 (25)5.7 goto语句 (26)三SQL SERVER数据库编写规范内容 (26)1.命名规范 (26)1)数据库名(v1.2版本中修订的) (26)2)数据库文件 (26)3)表(v1.2版本中修订的) (27)4)临时表名(v1.2版本中增加的) (27)5)属性(列或字段) (28)6)主键 (28)7)外键 (28)8)索引 (28)9)Default标识(默认值) (28)10)Rule标识(规则) (28)11)自定义数据类型 (28)12)触发器 (28)13)视图(v1.2版本中修订的) (28)14)存储过程(v1.2版本中修订的) (29)15)函数(v1.2版本中修订的) (29)16)变量名(v1.2版本中修订的) (30)17)角色 (30)18)用户 (30)2.注释规范 (30)1)存储过程、触发器和函数头的注释 (30)2)存储过程、触发器、函数每一步处理的注释 (31)3)修改代码部分的注释 (31)3.代码书写格式 (32)1)大小写约定 (32)2)代码缩进约定 (32)3)多表连接时,使用表的别名来引用列 (32)4)常用SQL语句的编写规范 (32)5)条件执行语句(IF)编写规范 (33)6)条件选择语句(CASE)编写规范 (33)7)循环执行语句(WHILE)编写规范 (33)附录 (35)一概述(一)编写目的为了健全公司软件源代码的管理,增加源代码的可读性,提高软件开发效率,特编写此规范。
此规范并非源代码编写的一个标准,而是作为一个参考,以培养开发人员良好的编程习惯。
(二)范围开发时源代码的命名、格式、注释规范,SQL SERVER数据库命名、格式、注释规范等。
二源代码编写规范内容1. 文件和目录●以相应文件目录的大类创建文件夹进行文件管理●VB文件管理目录●C#三层结构文件管理目录各架构之间的关系是:数据访问层(DAL)操作数据,业务逻辑层(BLL)调用数据访问层(DAL),表示层(用户界面层UI)调用业务逻辑层(BLL),实体类(Model)贯穿三层。
如下图:2. 命名规范(详细命名示例见附录)2.1窗体(v1.2版本中修订的)Frm+“操作动作+操作对象(各自首字母大写)”窗体的名字和它的内容关联一下。
如FrmPrintTable.frm, FrmAddUser.cs重新修订后:窗体命名要遵循以下原则:●“Frm+主要动作+(次要动作)+功能描述关键词”,各分界点首字母大写。
●主要动作:管理:Manager,查询:Query,统计:Stat,其他:Other●次要动作,可省略新增:New,添加:Add,编辑:Edit,查看:View列表:List,审批:Audit,确认:Confirm,选择:Choice●功能描述关键词,取符合该功能的1到3个关键英文单词或汉语拼音(均可缩写)并且首字母大写。
●如给当前功能添加子窗体(模式窗体)时,在主窗体名称后+“_”+ 子窗体的“主要动作”+(“次要动作”)+“功能描述关键词”。
●以上命名规则出现名称重复是按照名称加大写字母,并且按照字母顺序依次类推。
例如:卡信息查询:FrmQueryCardInfo.frm, FrmQueryCardInfoA.frm卡信息查询功能中的某一卡查看:FrmQueryCardInfo_Query One Card.frm2.2父窗体(v1.2版本中修订的)MDI+“操作动作+操作对象(各自首字母大写)”窗体的名字和它的内容关联一下。
如MDILogin.frm,MDIMain.cs重新修订后:父窗体命名要遵循以下原则:(详见窗体命名)●“MDI+(主要动作)+(次要动作)+功能描述关键词”,各分界点首字母大写。
●主要动作,可省略:管理:Manager,查询:Query,统计:Stat,其他:Other●次要动作,可省略:新增:New,添加:Add,编辑:Edit,查看:View列表:List,审批:Audit,确认:Confirm,选择:Choice●功能描述关键词,取符合该功能的1到3个关键英文单词或汉语拼音(均可缩写)并且首字母大写。
●如给当前功能添加子窗体(模式窗体)时,在主窗体名称后+“_”+ 子窗体的“主要动作”+(“次要动作”)+“功能描述关键词”。
●以上命名规则出现名称重复是按照名称加大写字母,并且按照字母顺序依次类推。
例如:功能主菜单窗体:MDIMain.frm2.3页面(v1.2版本中修订的)“操作动作+操作对象(各自首字母大写)”页面的名字和它的内容关联一下。
如NewSalesReturn.aspx重新修订后:页面命名要遵循以下原则:(详见窗体命名)●“主要动作+(次要动作)+功能描述关键词”,各分界点首字母大写。
●主要动作:管理:Manager,查询:Query,统计:Stat,其他:Other●次要动作,可省略:新增:New,添加:Add,编辑:Edit,查看:View列表:List,审批:Audit,确认:Confirm,选择:Choice●功能描述关键词,取符合该功能的1到3个关键英文单词或汉语拼音(均可缩写)并且首字母大写。
●如给当前功能添加子页面(当且仅当只能从一个主页面打开)时,在主页面名称后+“_”+ 子页面的“主要动作”+(“次要动作”)+“功能描述关键词”。
●以上命名规则出现名称重复是按照名称加大写字母,并且按照字母顺序依次类推。
例如:管理用户信息:ManagerUser.asp2.4类名(类文件名)1)名字应该能够标识事物的特性。
2)名字尽量不使用缩写,除非它是众所周知的。
3)名字可以有两个或三个单词组成,但通常不应多于三个。
4)在名字中,所有单词第一个字母大写。
包含ID的,ID全部大写。
5)使用名词或名词短语命名类。
6)少用缩写。
7)不要使用下划线字符 (_)。
如FileStream.cs, public class FileStream2.5类模块名:常用于VB开发中Cls+“标识事物的特性(首字母大写)”,如ClsPrint.cls2.6模块名:常用于VB开发中Bas+“标识事物的特性(首字母大写)”,如BasDrive.bas2.7函数名(过程名)∙用首字母大写的英文单词组合表示,用“动词+名词”的方法,其中至少有一个动词。
∙应该避免的命名方式:和继承来的函数名一样。
即使函数的参数不一样,也尽量不要这么做,除非想要重载它;只由一个动词组成,如:Save、Update。
改成如:SaveV alue、UpdateDataSet则比较好。
∙函数参数应该具有自我描述性,应该能够做到见其名而知其意。
2.8变量名1)变量数据类型,其前缀由三个字母组成,均需小写。
而且前缀可以被扩展,用来指明变量范围。
格式原则上“以变量类型的3个小写字母开头作为前缀(去掉非前置元音),前缀之后是首字母大写的一个或多个单词组合,该单词要指明变量的用途”为准,并且原则上不建议用下划线作为单词间的连接符。
2)对于变量命名,禁止取单个字符(如i、j、k...),建议除了要有具体含义外,还能表明其变量类型、数据类型等,但i、j、k作局部循环变量是允许的。
3)除非必要,不要用数字或较奇怪的字符来定义标识符。
4)全局级变量前缀加“g_”,模块级变量前缀加“m_”。
5)用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。
说明:下面是一些在软件中常用的反义词组。
add / remove begin / end create / destroyinsert / delete first / last get / releaseincrement / decrement put / getadd / delete lock / unlock open / closemin / max old / new start / stopnext / previous source / target show / hidesend / receive source / destinationcut / paste up / down如:变量类型 前缀 描述 示例Array arr 数组 arrDianLanBoolean bln 布尔值 blnFoundByte byt 字节型 bytRasterDataCurrency cur 货币型 curProductDate dat 日期型 datStartRunDouble dbl 双精度 dblChangDuError err 错误对象 errLoadData2.9对象名:同变量命名2.10控件名:同变量命名3. 注释规范注释符说明:vb采用“’”进行注释,c#采用“//”或“/* */”等进行注释。
3.1有效注释量一般情况下,源程序有效注释量必须在20%以上。
说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。
3.2说明性文件说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。