文档介绍：编码标准
批准人
刘岩
审核人
崔戈
拟制人
刘慧丰
批准日期
生效日期
关
联
文
件
沈阳东东系统集成有限公司
更改记录
序号
发行日
更改对象·更改内容
批准
审查
拟制
0
新发行
刘岩
崔戈
刘慧丰
目录
1. 目的 2/4
2. 编码的注意事项 2/4
3. 编码风格 2/4
4. 序言性注释格式 3/4
附录
头注释样例 1/4(附)
编码是以程序设计时做成的程序规范书、流程等逻辑设计书为基础。在编码时,为减少在编码水平上的个人差异、顺利地进入单体试验阶段,以及便于进行调试和提高维护效率,特制定本标准。
本标准作为代码的书写标准,其主要目的在于统一程序设计的记述风格,培养良好的编码****惯,使代码记述清晰、明确,具有良好的可读性。良好的编码****惯可以帮助程序员避开不必要的语法或语义错误,对出现的错误迅速定位。另外,良好的编码****惯还有助于在编码过程中对程序的设计思路进行验证和提示。
本规范作为编码的通常标准,希望每个人都可以通过按此规范进行编码,提高程序的可读性、可修改性及维护的效率。如果程序由用户指定记述标准或使用(半)自动生成工具时,可适当遵循其标准。
(1)认真分析理解系统设计书、程序设计书(有时也包括流程图)。在很好地理解上述文件的基础上编码(特别是在程序设计书与编码的担当者不同时)。对于不明确之处不可随意判断,应确认后再进行。
(2)要注意把编制容易理解(易读)的程序放到第一位。在头脑中要经常考虑程序的读者,按照向读者说明的方式来写是一个窍门。读起来容易理解的程序一般质量都比较好、修改维护也容易。
(3)在编码的过程中发现了设计上的问题时,要向上追溯到系统设计书/程序设计书。不可轻易地判断,而应经设计者确认。
(4)关于数据库的记录规范等的包含文件、模块头、宏等,要采用系统统一的规定。个人不可随意地制作。否则就会为以后修改、改造造成困难。
(5)在编码结束后,要对编码重查。不可未经充分的重查而随便进入下一步测试阶段。编码重查作为最简便的故障检查手段,也是非常有效的手段,有时可以检查出在试验工程中不能全部检查出的复杂的错误。
编码的目标首先是清晰正确,其次才是程序的效率。以下是在编程时应遵守规则。
(1)合理使用goto语句。合理使用goto语句可以提高代码的运行效率,但goto语句的使用会破坏程序的结构特性,因此要限制使用的范围。
(2)用括号体现优先级和嵌套的层次。用括号体现优先级和嵌套的层次可使程序更清晰,并且能够有效地避免二义性。
(3)利用标准书写格式提高程序的可读性。
用分层缩进显示嵌套结构的层次。
每行只写一条语句。
在注释段的周围加边框。
在注释段与程序段以及不同程序段之间插入空行。
(4)命名规则。命名应有实际意义,一般格式为:前缀+由形容词、名词或动词组成的词组。前缀由使用的语言决定。
(5)适当的注释。适当的注释能提高程序的可读性,但过多的注释不但不能提高程序的可读性,还会降低效率,因此注释一定要适当。注释分为序言性注释和功能性注释两种。在文件头、模块头、函数和过程的头部的注释属于序言性注释。包括以下几部分内容:
功能描述。对所执行的功能进行简略的介绍。
接口描述。简述各输入参数和返回值。
数据描述。简述用到的重要变量、结构和文件等。
履历描述。包括设计者、日期和版本,文件头还包括版权声名。
功能性注释嵌在源程序内部用来描述处理功能。
(6)输入数据的检查。所有输入数据都应经过检查。
(7)变量使用前要赋初值。
(8)错误处理。一定要对可能出现的错误进行处理,以避免故障引起停机。
(头注释)
头注释可以大致分为文件注释、模块注释、数据注释等。在写注释时推荐使用以下格式。
文件注释(文件头),文件注释记述以下信息
(a)文件识别信息
系统名(主模块时)
程序名或模块名
版本信息(包括时间)
所属(从属模块时)
担当
著作权声明
(b)文件说明信息
简介
功能说明(主要模块说明)
操作环境
H/W,PLATFORM,OS,MEMORY等
编译、连接信息
make file名,命令过程文件名,编译、连接选项(Option),应连接的装配模块文件名,子程序库名等
文件维护信息
版本,日期,作者所属部门名,作者姓名,补充说明等
创建信息
更改记录
(d)其它
系统使用说明(主模块时)
注意事项
文件管理工具的附加信息
需要特别说明的信息
SYSTEM
PROGRAM/MODULE
VERSI