某系统集成公司编码标准概述

1、编码标准 批准人刘岩审核人崔戈拟制人刘慧丰批准日期19995112生效日期19995112关联文件沈阳东东系系统集成成有限公公司更改记录序号发行日更改对象更改内内容批准审查拟制019995112新发行刘岩崔戈刘慧丰目 录1.目的的2/42.编码码的注意意事项2/43.编码码风格 2/44.序言言性注释释格式3/4附录头注释样例例1/4(附)1.目的编码是以程程序设计计时做成成的程序序规范书书、流程程等逻辑辑设计书书为基础础。在编编码时，为为减少在在编码水水平上的的个人差差异、顺顺利地进进入单体体试验阶阶段,以及便便于进行行调试和和提高维维护效率率，特制制定本标标准。本标准作为为代码的的书写标标

2、准，其其主要目目的在于于统一程程序设计计的记述述风格，培培养良好好的编码码习惯，使使代码记记述清晰晰、明确确，具有有良好的的可读性性。良好好的编码码习惯可可以帮助助程序员员避开不不必要的的语法或或语义错错误，对对出现的的错误迅迅速定位位。另外外，良好好的编码码习惯还还有助于于在编码码过程中中对程序序的设计计思路进进行验证证和提示示。本规范作为为编码的的通常标标准，希希望每个个人都可可以通过过按此规规范进行行编码，提提高程序序的可读读性、可可修改性性及维护护的效率率。如果果程序由由用户指指定记述述标准或或使用（半半）自动动生成工工具时，可可适当遵遵循其标标准。2.编码的的注意事事项(1)认真真分

3、析理理解系统统设计书书、程序序设计书书（有时时也包括括流程图图）。在在很好地地理解上上述文件件的基础础上编码码 （特别别是在程程序设计计书与编编码的担担当者不不同时）。对对于不明明确之处处不可随随意判断断，应确确认后再再进行。(2)要注注意把编编制容易易理解（易易读）的的程序放放到第一一位。在在头脑中中要经常常考虑程程序的读读者，按按照向读读者说明明的方式式来写是是一个窍窍门。读读起来容容易理解解的程序序一般质质量都比比较好、修修改维护护也容易易。(3)在编编码的过过程中发发现了设设计上的的问题时时，要向向上追溯溯到系统统设计书书程序序设计书书。不可可轻易地地判断，而而应经设设计者确确认。(4

4、)关于于数据库库的记录录规范等等的包含含文件、模模块头、宏宏等，要要采用系系统统一一的规定定。个人人不可随随意地制制作。否否则就会会为以后后修改、改改造造成成困难。(5)在编编码结束束后，要要对编码码重查。不不可未经经充分的的重查而而随便进进入下一一步测试试阶段。编编码重查查作为最最简便的的故障检检查手段段，也是是非常有有效的手手段，有有时可以以检查出出在试验验工程中中不能全全部检查查出的复复杂的错错误。3.编码风风格编码的目标标首先是是清晰正正确，其其次才是是程序的的效率。以以下是在在编程时时应遵守守规则。(1)合理理使用ggotoo语句。合合理使用用gotto语句句可以提提高代码码的运行行

5、效率，但但gotto语句句的使用用会破坏坏程序的的结构特特性，因因此要限限制使用用的范围围。(2)用括括号体现现优先级级和嵌套套的层次次。用括括号体现现优先级级和嵌套套的层次次可使程程序更清清晰，并并且能够够有效地地避免二二义性。(3)利用用标准书书写格式式提高程程序的可可读性。用分层缩进进显示嵌嵌套结构构的层次次。每行只写一一条语句句。在注释段的的周围加加边框。在注释段与与程序段段以及不不同程序序段之间间插入空空行。(4)命名名规则。命命名应有有实际意意义，一一般格式式为：前前缀+由由形容词词、名词词或动词词组成的的词组。前前缀由使使用的语语言决定定。(5)适当当的注释释。适当当的注释释能提

6、高高程序的的可读性性，但过过多的注注释不但但不能提提高程序序的可读读性，还还会降低低效率，因因此注释释一定要要适当。注注释分为为序言性性注释和和功能性性注释两两种。在在文件头头、模块块头、函函数和过过程的头头部的注注释属于于序言性性注释。包包括以下下几部分分内容：功能描述。对对所执行行的功能能进行简简略的介介绍。接口描述。简简述各输输入参数数和返回回值。数据描述。简简述用到到的重要要变量、结结构和文文件等。履历描述。包包括设计计者、日日期和版版本，文文件头还还包括版版权声名名。功能性注释释嵌在源源程序内内部用来来描述处处理功能能。(6)输入入数据的的检查。所所有输入入数据都都应经过过检查。(7

7、)变量量使用前前要赋初初值。(8)错误误处理。一一定要对对可能出出现的错错误进行行处理，以以避免故故障引起起停机。4.序言性性注释格格式（头头注释）头注释可以以大致分分为文件件注释、模模块注释释、数据据注释等等。在写写注释时时推荐使使用以下下格式。文件注释（文文件头）,文件注注释记述述以下信信息 (a)文文件识别别信息系统名（主主模块时时）程序名或模模块名版本信息（包包括时间间）所属（从属属模块时时）担当著作权声明明(b)文件件说明信信息简介功能说明（主主要模块块说明）操作环境HH/W，PLAATFOORM，OS，MEMMORYY等编译、连接接信息mmakee fiile名名，命令令过程文文件

8、名，编编译、连连接选项项（Opptioon），应应连接的的装配模模块文件件名，子子程序库库名等文件维护信信息版本，日期期，作者者所属部部门名，作作者姓名名，补充充说明等等创建信息更改记录(d)其它它系统使用说说明（主主模块时时）注意事项文件管理工工具的附附加信息息需要特别说说明的信信息SYSTEEMPROGRRAM/MODDULEEVERSIIONMASTEER MMODUULEAUTHOORCOPYRRIGHHTABSTRRACTT/PUURPOOSEFUNCTTIONNENVIRRONMMENTTMAKE OPTTIONNCREATTEUPDATTEUSAGEENOTESPECIIAL I

9、NFFO说明：“”表示标标准项目目，“”表示可可选项目目。模块注释（模模块头）。模模块注释释对了解解模块的的概要非非常有效效，而且且在维护护时也同同样有效效，所以以一定要要记述。模模块注释释记述以以下信息息模块名模块编号版本信息简介功能说明影响注意事项返回值参数说明担当创建信息更改记录MODULLEIDVERSIIONABSTRRACTTFUNCTTIONNSIDE-EFFFECTTNOTERETURRNARGUMMENTTAUTHOORCREATTEUPDATTE说明：“”表示标标准项目目，“”表示可可选项目目。数据注释数据注释用用来帮助助对数据据结构或或数据表表、数组组等内容容的理解解。标

10、识符名（用用于标识识符定义义）数据结构名名称数据类型简介注意事项TAGDATADATA-TYPPEABSTRRACTTNOTE说明：“”表示标标准项目目，“”表示可可选项目目。附录: 头头注释样样例以下为C语语言源文文件的注注释样例例主模块文件件头（程程序的主主模块，生生成命令令程序。）/*/*/* 系统统： 系统名名 */* 用户户： 用户名名 */* 程序序： 程序名名 - 标题 */* 担当当部门： XXXXX*/* YYYYY*/* (CC)Coopyrrighht SShennyanng NNETSS innteggrattionn Coorpoorattionn 19996*/*

11、Alll RRighhts Resservved. */*/* VEERSIION DAATE BBY CHAANGEE/COOMMEENT*/* VVX.000 YYY-MMM/DDD 姓名 Creeatee*/* VVX.XXX YYY-MMM/DDD 姓名 更改 概要、更更改理由由*/*/* 功能能概略：功能概概略 */* 异异常处理理：异常常处理 */* 调调用方法法： */* 程序名名 Argg1 Argg2 */* 参参数说明明： */* II/0 参数数名 内内容 */* I Argg1 内容容说明 */* I Argg2 内容容说明 */* 适适用计算算机：计计算机类类型、型型

12、号 */* OOS： OOS名称称（版本本） */* 大大小： 内存 MMB */* 交换 MMB */* 编编译： 编译系系统名称称（版本本） */* 连连接信息息： 连接接信息 */*/*/* 请请注意：未经许许可，不不可擅自自使用、转转载本内内容的一一部分或或全部。*/*/*/模块文件头头（从属属模块）/*/*/* 系统统： 系系统名 */* 用户户： 用用户名 */* 模块块： 模模块名- 标题题 */* 所属属： 主主模块名名或程序序名 */* 担当当部门： XXXXXX */* YYYYY */* (CC)Coopyrrighht SShennyanng NNETSS Innteg

13、grattionn Coorpoorattionn 19996 */* AAll Rigghtss Reeserrvedd. */*/* VVERSSIONN DDATEE BY CHAANGEE/COOMMEENT */* VX.00 YY-MM/DD 姓名名 Creeatee */* VX.XX YY-MM/DD 姓名名 更改概概要、更更改理由由 */*/* 功功能概略略：功能能概略 */* 异常处处理：异异常处理理 */* 调用顺顺序： */* iint I11 */* : */* ccharr 011 */* ssts = (&I11,.,&011); */* 参数说说明： */* I

14、/0 变量名名 内容容 */* II II1 内容容说明 */* : */* II 001 内容容说明 */* 00 SSTS 内容容说明 */* 适适用计算算机：计计算机类类型、型型号 */* OOS： OOS名称称（版本本） */* 编编译： 编编译系统统（版本本） */* 连连接信息息： 连接信信息 */*/* 请注注意：未未经许可可，不可可擅自使使用、转转载本内内容的一一部分或或全部。*/*/文件头例/* * Coppyriightt 119944-19995 Miicroosofft CCorpporaatioon. Alll RRighhts Resservved. *PROOGR

15、AAM:winnproog.cc * *PURRPOSSE:Winndowws pproggramm. * *PLAATFOORMSS:Winndowws 995 * *FUNNCTIIONSS: *WinnMaiin() - callls iniitiaalizzatiion funnctiion, prroceessees mmesssagee looop *IniitApppliicattionn() - IInittiallizees wwinddow datta nnd rregiisteers winndoww *IniitInnstaancee() -saavess innsta

16、ancee haandlle aand creeatees mmainn wiindoow *MaiinWiindPProcc() Proocesssess meessaagess *Aboout() - Prroceess mennssaagess foor Aboout diialoog bbox */模块头1/* * MODDULEE: mmainn *VERRSIOON: 11.1 *ABSSTRAACT: mmainn fuuncttionn off prrogrram *FUNNCTIION: ffuncctioon oof mmainn *ARGGUMEENT: * arrgcc

17、ouunt of commmannd llinee arrgummentt * arrgvcommmannd llinee arrgummentt *RETTURNN: * 0norrmall ennd * 1abnnormmal endd *SIDDE-EEFFEECT: *NOTTE: *CREEATEE: 996-007Netts1 *UPDDATEE: 996-008Netts2 * tthe reaasonn *UPDDATEE: 996-009Netts3 */模块头2/*/* */* 模模块： 模块块名 - 标题题 */* 功功能概略略： 功能概概略 */* */*/类型声明/* * TAGG: DDemooStrructt *ABSSTRAACT: DDemoo