银行信息技术标准研发领域开发语言指引试行.docx
- 文档编号:11893822
- 上传时间:2023-06-03
- 格式:DOCX
- 页数:7
- 大小:19.28KB
银行信息技术标准研发领域开发语言指引试行.docx
《银行信息技术标准研发领域开发语言指引试行.docx》由会员分享,可在线阅读,更多相关《银行信息技术标准研发领域开发语言指引试行.docx(7页珍藏版)》请在冰点文库上搜索。
银行信息技术标准研发领域开发语言指引试行
信息技术标准
CEB-TS/DEV-CD-001-2019
研发领域
开发语言指引
(试行)
修订记录
修订日期
主要修订内容描述
修订者
审阅者
审阅日期
2019-04-01
初稿编写
2019-05-10
依据审阅和征求的意见进行修订
1前言
1.1目标
为保证应用开发系统具有统一的编码风格和命名规则,保证程序运行的正确性,提高系统运行的稳定性、扩展性和高效性,为软件的修改、维护、升级提供更大的方便性,特制定此开发编码规范指引。
开发语言编码的总体原则是:
⏹保持程序风格整体一致;
⏹便于维护人员理解程序;
⏹对于不同的开发平台具有延用性;
⏹便于程序员修改、编写程序;
⏹保证程序正确运行;
⏹充分表达程序的逻辑算法以及程序员的思维。
1.2用途
开发规范指引制定了在程序开发过程中必须遵守的各种规则,依照规则进行开发,不仅可以提高开发效率,还能便于后期的维护和测试工作。
制定编码规范指引同时也有助于提高源码的可读性,可维护性,对于提高团队开发项目的整体效率更是不可缺少的。
通过本规范指引的实施,将为项目开发带来以下好处:
⏹代码的编写保持一致性;
⏹提高代码的可读性和可维护性;
⏹在团队开发一个项目的情况下,实现程序员之间的代码共享;
⏹易于代码的回顾。
1.3内容简介
本指引主要包括编程基本规范要求和排版规范
1.4阅读对象
本指引的阅读对象是我行研发领域相关的技术及管理人员,以及我行软件开发项目的服务外包人员。
1.5编制背景
本指引由信息科技部提出并进行归口管理。
本指引起草单位:
信息科技部开发中心。
本指引主要起草人:
于克干等。
2适用范围
本指引适用于全行。
本指引适用于我行在建以及已上线的软件研发项目,适用于项目在开发编码阶段对编码规范进行指导。
3规范性引用文件
4术语及定义
术语
定义
5编程规范
5.1基本要求
1.程序的控制结构只允许采用下列几种:
顺序结构、条件(if)转移结构、循环结构、分情况(case)结构。
尽可能少使用BREAK、CONTINUE等转移语句,避免从循环引出多个出口,尽可能少使用GOTO语句。
避免大量的条件嵌套和循环嵌套;
2.各模块之间要求松耦合,内聚度高。
注意将一些功能较为独立的模块设计为公用模块,增强系统的可扩充性。
尽量保持函数功能的单一性,不要使其过于复杂;
3.注释和代码一致。
修改代码后必须修改相应的注释;
4.在对数据库进行完UPDATE、INSERT、DELETE等操作后要适时COMMIT或者ROLLBACK,以释放资源,防止死锁。
使用高效率的查询条件。
程序运行尽量适合数据字典的结构方式;
5.如果源代码有不能被理解的行为,在和上届编码人员交流并理解程序之前,不可对代码进行修改、删除等任何动作;
6.要注意对原有的注释、联机帮助、文档进行相应的修改、追加。
5.2排版规范
5.2.1文件头
在每个源文件的头部要有必要的注释信息,包括:
文件名;版本号;作者;生成日期;模块功能描述;主要过程清单及本文件历史修改记录,文件历史修改记录要包括:
修改序号、修改日期,修改人,修改内容等。
使用如下文件头:
/*************************************************************
*
*文件名称:
TLog()
*文件功能:
写log
*编程者:
*初作时间:
2002/03/09
*版本:
*输入说明:
*
*输出说明:
*
*程序流程:
*
*----------------------------------------------------------
*修改序号:
时间:
修改者:
*修改内容:
*
*----------------------------------------------------------
*修改序号:
时间:
修改者:
*修改内容:
*
*----------------------------------------------------------
*
*
*************************************************************/
5.2.2缩进
7.标准的、基于制表位的嵌套块应该被缩进四个空格。
一般的vi等编辑器的缺省tab为8个空格,修改为4个空格;
8.函数或交易的定义从第一列写起;
9.函数体缩进4个空格;
10.条件语句、循环语句、分支语句的语句体缩进4个空格;
11.由于各个编辑器对于TAB键和空格对应关系的定义不同,所以导致一个格式良好的程序在另外的编辑器中却参差不齐,所以禁止用TAB缩进。
5.2.3空格
12.关键词和字符之间要加适当的空格;
13.函数名之后不要留空格,紧跟左括号‘(’,以与关键字区别;
14.‘,’之后要留空格;
15.赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“=”、“+=”“>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后应当加空格;
16.一元操作符如“!
”、“~”、“++”、“--”、“&”(地址运算符)等前后不加空格;
17.象“[]”、“.”、“->”这类操作符前后不加空格。
5.2.4空行
空行起着分隔程序段落的作用。
空行得体(不过多也不过少)将使程序的布局更加清晰。
如下情况需使用空行:
⏹在每个函数定义结束之后都要加空行
⏹在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔
⏹在函数体内,变量说明和函数实现体之间应用空行分开
5.2.5续行
18.不允许把多个短语句写在一行中,即一行只写一条语句;
19.if、for、while、do等语句自占一行,执行语句不得紧跟其后。
不论执行语句有多少都要加{}。
这样可以防止书写失误;
20.建议在定义变量的同时初始化该变量;
21.较长的语句、表达式建议分成多行写;
22.如果是函数说明,下一行的第一个函数参数应当与函数的第一个函数参数位于同一列;
23.如果是长表达式,建议在低优先级操作符处拆分成新行,操作符放在新行之首(以便突出操作符)。
拆分出的新行应进行适当的缩进,使排版整齐,语句可读:
示例:
if((very_longer_variable1>=very_longer_variable12)
&&(very_longer_variable3<=very_longer_variable14)
&&(very_longer_variable5<=very_longer_variable16))
{
dosomething();
}
for(very_longer_initialization;
very_longer_condition;
very_longer_update)
{
dosomething();
}
24.在使用C语言的续行符‘\’时,在每一行的最后一个可见字符‘\’的后面不能有任何其它不可见字符,如空格和TAB等,以免造成不同平台间的移植问题;
25.代码行最大长度建议控制在70至80个字符以内。
代码行避免过长,否则不利于程序代码的阅读和打印。
6附录A
7参考文献
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 银行 信息技术 标准 研发 领域 开发 语言 指引 试行