文档介绍：该【某系统集成公司编码标准概述 】是由【静雨蓝梦】上传分享，文档一共【14】页，该文档可以免费在线阅读，需要了解更多关于【某系统集成公司编码标准概述 】的内容，可以使用淘豆网的站内搜索功能，选择自己适合的文档，以下文字是截取该文章内的部分文字，如需要获得完整电子版，请下载此文档到您的设备，方便您编辑和打印。编码标准
批准人
刘岩
审核人
崔戈
拟制人
刘慧丰
批准日期
1999..
生效日期
1999..
关
联
文
件
沈阳东东系系统集成有有限公司
更改记录
序号
发行日
更改对象··更改内容容
批准
审查
拟制
0
1999..
新发行
刘岩
崔戈
刘慧丰
目录
1. 目的的 2/4
2. 编码码的注意事事项 2/4
3. 编码码风格 2/4
4. 序言言性注释格格式 3/4
附录
头注释样例例 1/4(附)
编码是以程程序设计时时做成的程程序规范书书、流程等等逻辑设计计书为基础础。在编码码时,为减减少在编码码水平上的的个人差异异、顺利地地进入单体体试验阶段段,以及便于于进行调试试和提高维维护效率,特特制定本标标准。
本标准作为为代码的书书写标准,其其主要目的的在于统一一程序设计计的记述风风格,培养养良好的编编码****惯,使使代码记述述清晰、明明确,具有有良好的可可读性。良良好的编码码****惯可以以帮助程序序员避开不不必要的语语法或语义义错误,对对出现的错错误迅速定定位。另外外,良好的的编码****惯惯还有助于于在编码过过程中对程程序的设计计思路进行行验证和提提示。
本规范作为为编码的通通常标准,希望每个人都可以通过按此规范进行编码,提高程序的可读性、可修改性及维护的效率。如果程序由用户指定记述标准或使用(半)自动生成工具时,可适当遵循其标准。
(1)认真真分析理解解系统设计计书、程序序设计书(有有时也包括括流程图)。在在很好地理理解上述文文件的基础础上编码(特别是是在程序设设计书与编编码的担当当者不同时时)。对于于不明确之之处不可随随意判断,应应确认后再再进行。
(2)要注注意把编制制容易理解解(易读)的的程序放到到第一位。在在头脑中要要经常考虑虑程序的读读者,按照照向读者说说明的方式式来写是一一个窍门。读读起来容易易理解的程程序一般质质量都比较较好、修改改维护也容容易。
(3)在编编码的过程程中发现了了设计上的的问题时,要要向上追溯溯到系统设设计书/程程序设计书书。不可轻轻易地判断断,而应经经设计者确确认。
(4)关于于数据库的的记录规范范等的包含含文件、模模块头、宏宏等,要采采用系统统统一的规定定。个人不不可随意地地制作。否否则就会为为以后修改改、改造造造成困难。
(5)在编编码结束后后,要对编编码重查。不不可未经充充分的重查查而随便进进入下一步步测试阶段段。编码重重查作为最最简便的故故障检查手手段,也是是非常有效效的手段,有有时可以检检查出在试试验工程中中不能全部部检查出的的复杂的错错误。
编码的目标标首先是清清晰正确,其其次才是程程序的效率率。以下是是在编程时时应遵守规规则。
(1)合理理使用gooto语句句。合理使使用gotto语句可可以提高代代码的运行行效率,但但gotoo语句的使使用会破坏坏程序的结结构特性,因因此要限制制使用的范范围。
(2)用括括号体现优优先级和嵌嵌套的层次次。用括号号体现优先先级和嵌套套的层次可可使程序更更清晰,并并且能够有有效地避免免二义性。
(3)利用用标准书写写格式提高高程序的可可读性。
用分层缩进进显示嵌套套结构的层层次。
每行只写一一条语句。
在注释段的的周围加边边框。
在注释段与与程序段以以及不同程程序段之间间插入空行行。
(4)命名名规则。命命名应有实实际意义,一一般格式为为:前缀++由形容词词、名词或或动词组成成的词组。前前缀由使用用的语言决决定。
(5)适当当的注释。适适当的注释释能提高程程序的可读读性,但过过多的注释释不但不能能提高程序序的可读性性,还会降降低效率,因因此注释一一定要适当当。注释分分为序言性性注释和功功能性注释释两种。在在文件头、模模块头、函函数和过程程的头部的的注释属于于序言性注注释。包括括以下几部部分内容::
功能描述。对对所执行的的功能进行行简略的介介绍。
接口描述。简简述各输入入参数和返返回值。
数据描述。简简述用到的的重要变量量、结构和和文件等。
履历描述。包包括设计者者、日期和和版本,文文件头还包包括版权声声名。
功能性注释释嵌在源程程序内部用用来描述处处理功能。
(6)输入入数据的检检查。所有有输入数据据都应经过过检查。
(7)变量量使用前要要赋初值。
(8)错误误处理。一一定要对可可能出现的的错误进行行处理,以以避免故障障引起停机机。
(头注释释)
头注释可以以大致分为为文件注释释、模块注注释、数据据注释等。在在写注释时时推荐使用用以下格式式。
文件注释(文文件头),,文件注释释记述以下下信息
(a)文文件识别信信息
系统名(主主模块时)
程序名或模模块名
版本信息(包包括时间)
SYSTEEM
PROGRRAM/MMODULLE
VERSIION
MASTEERMOODULEE
所属(从属属模块时)
担当
著作权声明明
(b)文件件说明信息息
简介
功能说明(主主要模块说说明)
操作环境
HH/W,PLATTFORMM,OS,MEMOORY等
编译、连接接信息
maakeffile名名,命令过过程文件名名,编译、连连接选项(Option),应连接的装配模块文件名,子程序库名等
文件维护信信息
版本,日期期,作者所所属部门名名,作者姓姓名,补充充说明等
创建信息
更改记录
(d)其它它
系统使用说说明(主模模块时)
注意事项
文件管理工工具的附加加信息
需要特别说说明的信息息
AUTHOOR
COPYRRIGHTT
ABSTRRACT//PURPPOSE
FUNCTTION
ENVIRRONMEENT
MAKEOPTIION
CREATTE
UPDATTE
USAGEE
NOTE
SPECIIALIINFO
说明:“­”表示标准准项目,“¯”表示可选选项目。
模块注释(模模块头)。模模块注释对对了解模块块的概要非非常有效,而而且在维护护时也同样样有效,所所以一定要要记述。模模块注释记记述以下信信息
模块名
模块编号
版本信息
简介
功能说明
影响
注意事项
返回值
参数说明
担当
创建信息
更改记录
MODULLE
ID
VERSIION
ABSTRRACT
FUNCTTION
SIDE--EFFEECT
NOTE
RETURRN
ARGUMMENT
AUTHOOR
CREATTE
UPDATTE
说明:“­”表示标准准项目,“¯”表示可选选项目。
数据注释
数据注释用用来帮助对对数据结构构或数据表表、数组等等内容的理理解。
标识符名(用用于标识符符定义)
数据结构名名称
数据类型
简介
注意事项
TAG
DATA
DATA--TYPEE
ABSTRRACT
NOTE
说明:“­”表示标准准项目,“¯”表示可选选项目。
附录:头头注释样例例
以下为C语语言源文件件的注释样样例
主模块文件件头(程序序的主模块块,生成命命令程序。)
/******************************************************************************//
/* */
/*系系统:系统名 */
/*用用户:用户名 */
/*程程序:程序名-标题 */
/*担担当部门::XXXXX */
/*YYYYY */
/*(C)CCopyrrighttSheenyanngNEETSiinteggratiionCCorpooratiion11996 */
/*AlllRiightssResserveed. */
/*******************************************************************************/
/**VEERSIOONDDATEBYCHAANGE//COMMMENT */
/*VX..00YYY-MM//DD姓名CCreatte */
/*VX..XXYYY-MM//DD姓名更改概要、更更改理由 */
/*******************************************************************************/
/**功能能概略:功功能概略 */
/*异常处处理:异常常处理 */
/*调用方方法: */
/*程序名名Arg11Arg22 */
/*参数说说明: */
/*I/0参参数名内容容 */
/*IArgg1内内容说明 */
/*IArgg2内内容说明 */
/*适用计计算机:计计算机类型型、型号 */
/*OS::OS名称(版版本) */
/*大小::内内存MMB */
/*交换换MB */
/*编译::编编译系统名名称(版本本) */
/*连接信信息:连接信信息 */
/*******************************************************************************/
/** */
/*请注意意:未经许许可,不可可擅自使用用、转载本本内容的一一部分或全全部。 */
/* */
/*******************************************************************************/
模块文件头头(从属模模块)