规范

转载 2006年06月07日 21:44:00

  当前是:全文显示
 

  随着软件产品的功能增加和版本的提高,代码越来越复杂,源文件也越来越多, 对于软件开发人员来说,除了保证程序运行的正确性和提高代码的运行效率之外,规范风格的编码会对软件的升级、修改、维护带来极大的方便性,也保证程序员不会陷入"代码泥潭"中无法自拔。开发一个成熟的软件产品,除了有详细丰富的开发文档之外,必须在编写代码的时候就有条不紊,细致严谨。
  以下的编码规范包含了程序排版、注释、命名、可读性、变量、程序效率、质量保证、代码编译、代码测试和版本控制等注意事项。

  一、排版:
  1.关键词和操作符之间加适当的空格。
  2.相对独立的程序块与块之间加空行
  3.较长的语句、表达式等要分成多行书写。
  4.划分出的新行要进行适应的缩进,使排版整齐,语句可读。
  5.长表达式要在低优先级操作符处划分新行,操作符放在新行之首。
  6.循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分。
  7.若函数或过程中的参数较长,则要进行适当的划分。
  8.不允许把多个短语句写在一行中,即一行只写一条语句。
  9.函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格。
  10.C/C++语言是用大括号'{'和'}'界定一段程序块的,编写程序块时'{'和
   '}'应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体
    的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、
    switch、case语句中的程序都要采用如上的缩进方式。

  二、注释
  1.注释要简单明了。
  2.边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。
  3.在必要的地方注释,注释量要适中。注释的内容要清楚、明了,含义准确,防止
   注释二义性。保持注释与其描述的代码相邻,即注释的就近原则。
  4.对代码的注释应放在其上方相邻位置,不可放在下面。
  5.对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域
   的注释应放在此域的右方;同一结构中不同域的注释要对齐。
  6.变量、常量的注释应放在其上方相邻位置或右方。
  7.全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它
   以及存取时注意事项等的说明。
  8.在每个源文件的头部要有必要的注释信息,包括:文件名;版本号;作者;生成
   日期;模块功能描述(如功能、主要算法、内部各部分之间的关系、该文件与其
   它文件关系等);主要函数或过程清单及本文件历史修改记录等。
  9.在每个函数或过程的前面要有必要的注释信息,包括:函数或过程名称;功能描
   述;输入、输出及返回值说明;调用关系及被调用关系说明等。

  三、命名
  1.较短的单词可通过去掉"元音"形成缩写;
  2.较长的单词可取单词的头几发符的优先级,并用括号明确表达式的操作顺序,避
   免使用默认优先级。
  3.使用匈牙利表示法

  四、可读性
  1.避免使用不易理解的数字,用有意义的标识来替代。
  2.不要使用难懂的技巧性很高的语句。
  3.源程序中关系较为紧密的代码应尽可能相邻。

  五、变量
  1.去掉没必要的公共变量。
  2.构造仅有一个模块或函数可以修改、创建,而其余有关模块或函数只访问的公共
   变量,防止多个不同模块或函数都可以修改、创建同一公共变量的现象。
  3.仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。
  4.明确公共变量与操作此公共变量的函数或过程的关系,如访问、修改及创建等。
  5.当向公共变量传递数据时,要十分小心,防止赋与不合理的值或越界等现象发生。
  6.防止局部变量与公共变量同名。
  7.仔细设计结构中元素的布局与排列顺序,使结构容易理解、节省占用空间,并减
   少引起误用现象。
  8.结构的设计要尽量考虑向前兼容和以后的版本升级,并为某些未来可能的应用保
   留余地(如预留一些空间等)。
  9.留心具体语言及编译器处理不同数据类型的原则及有关细节。
  10.严禁使用未经初始化的变量。声明变量的同时对变量进行初始化。
  11.编程时,要注意数据类型的强制转换。

  六、函数、过程
  1.函数的规模尽量限制在200行以内。
  2.一个函数最好仅完成一件功能。
  3.为简单功能编写函数。
  4.函数的功能应该是可以预测的,也就是只要输入数据相同就应产生同样的输出。
  5.尽量不要编写依赖于其他函数内部实现的函数。
  6.避免设计多参数函数,不使用的参数从接口中去掉。
  7.用注释详细说明每个参数的作用、取值范围及参数间的关系。
  8.检查函数所有参数输入的有效性。
  9.检查函数所有非参数输入的有效性,如数据文件、公共变量等。
  10.函数名应准确描述函数的功能。
  11.避免使用无意义或含义不清的动词为函数命名
  12.函数的返回值要清楚、明了,让使用者不容易忽视错误情况。
  13/明确函数功能,精确(而不是近似)地实现函数设计。
  14.减少函数本身或函数间的递归调用。
  15.编写可重入函数时,若使用全局变量,则应通过关中断、信号量(即P、V操作)
    等手段对其加以保护。

  七、可测性
  1.在编写代码之前,应预先设计好程序调试与测试的方法和手段,并设计好各种调
  测开关及相应测试代码如打印函数等。
  2.在进行集成测试/系统联调之前,要构造好测试环境、测试项目及测试用例,同时
  仔细分析并优化测试用例,以提高测试效率。

  八、程序效率
  1.编程时要经常注意代码的效率。
  2.在保证软件系统的正确性、稳定性、可读性及可测性的前提下,提高代码效率。
  3.不能一味地追求代码效率,而对软件的正确性、稳定性、可读性及可测性造成影
   响。
  4.编程时,要随时留心代码效率;优化代码时,要考虑周全。
  5.要仔细地构造或直接用汇编编写调用频繁或性能要求极高的函数。
  6.通过对系统数据结构划分与组织的改进,以及对程序算法的优化来提高空间效率。
  7.在多重循环中,应将最忙的循环放在最内层。
  8.尽量减少循环嵌套层次。
  9.避免循环体内含判断语句,应将循环语句置于判断语句的代码块之中。
  10.尽量用乘法或其它方法代替除法,特别是浮点运算中的除法。

  九、质量保证
  1.在软件设计过程中构筑软件质量。
  代码质量保证优先原则
  (1)正确性,指程序要实现设计要求的功能。
  (2)稳定性、安全性,指程序稳定、可靠、安全。
  (3)可测试性,指程序要具有良好的可测试性。
  (4)规范/可读性,指程序书写风格、命名规则等要符合规范。
  (5)全局效率,指软件系统的整体效率。
  (6)局部效率,指某个模块/子模块/函数的本身效率。
  (7)个人表达方式/个人方便性,指个人编程习惯。
  2.只引用属于自己的存贮空间。
  3.防止引用已经释放的内存空间。
  4.过程/函数中分配的内存,在过程/函数退出之前要释放。
  5.过程/函数中申请的(为打开文件而使用的)文件句柄,在过程/函数退出前要关闭。
  6.防止内存操作越界。
  7.时刻注意表达式是否会上溢、下溢。
  8.认真处理程序所能遇到的各种出错情况。
  9.系统运行之初,要初始化有关变量及运行环境,防止未经初始化的变量被引用。
  10.系统运行之初,要对加载到系统中的数据进行一致性检查。
  11.严禁随意更改其它模块或系统的有关设置和配置。
  12.不能随意改变与其它模块的接口。
  13.充分了解系统的接口之后,再使用系统提供的功能。
  14.要时刻注意易混淆的操作符。当编完程序后,应从头至尾检查一遍这些操作符。
  15.不使用与硬件或操作系统关系很大的语句,而使用建议的标准语句。
  16.建议:使用第三方提供的软件开发工具包或控件时,要注意以下几点:
  (1)充分了解应用接口、使用环境及使用时注意事项。
  (2)不能过分相信其正确性。
  (3)除非必要,不要使用不熟悉的第三方工具包与控件。

  十、代码编译
  1.编写代码时要注意随时保存,并定期备份,防止由于断电、硬盘损坏等原因造成
   代码丢失。
  2.同一项目组内,最好使用相同的编辑器,并使用相同的设置选项。
  3.合理地设计软件系统目录,方便开发人员使用。
  4.打开编译器的所有告警开关对程序进行编译。
  5.在同一项目组或产品组中,要统一编译开关选项。
  6.使用工具软件(如Visual SourceSafe)对代码版本进行维护。

  十一、代码测试、维护
  1.单元测试要求至少达到语句覆盖。
  2.单元测试开始要跟踪每一条语句,并观察数据流及变量的变化。
  3.清理、整理或优化后的代码要经过审查及测试。
  4.代码版本升级要经过严格测试。

良好的日志记录规范

平常我的系统开发运行过程中,记录关键信息对于完善和修改提出了明确的建议。但是在现实的一些应用中的日志记录比较混乱,导致无法准确快速的定位问题发生的地方和问题发生的时候以及问题发生的场景。我就依据我平时...
  • Scalzdp
  • Scalzdp
  • 2014年04月28日 11:26
  • 13787

理解AMD ,CMD,CommonJS规范

这是一篇关于javascript模块化AMD,CMD,CommonJS的学习总结,作为记录也给同样对三种方式有疑问的童鞋们,有不对或者偏差之处,望各位大神指出,不胜感激。 本篇默认读者大概知道req...
  • xcymorningsun
  • xcymorningsun
  • 2016年09月30日 10:33
  • 4289

Java语言规范

-- Start Java语言规范(Java Language Specification) 和Java虚拟机规范(Java Virtual Machine Specification) 描述了更多...
  • shangboerds
  • shangboerds
  • 2012年04月20日 14:10
  • 1668

Java学习——传说中的13个规范

早就听说J2EE有十三个规范,可是看完视频我都没有发现有什么规范,这就让我纳闷了,都说学习java就是学习十三个规范,可是它到底是什么呢? 原来十三个规范就是十三个API文档,视频里讲到的都...
  • u010168160
  • u010168160
  • 2015年07月15日 07:58
  • 3829

怎样写出规范的shell脚本(仅限Scripting with style)

目录:Area1:某位博友总结的shell代码规范  Area2:一篇比较规范的脚本范例 Area3:书籍中提及的Scripting with style Area4:shell脚本...
  • USBdrivers
  • USBdrivers
  • 2013年02月04日 10:06
  • 1836

《Java虚拟机规范》阅读(一):简介和Java虚拟机结构

前言   说到学习jvm,其实我本人并不认为学习完以后会对目前工作有什么太大的帮助。但是为了深入了解java体系,使自己在看待问题上能够看到更本质的部分还是必须要学习的。同时对于自己的技术也是一...
  • u011279649
  • u011279649
  • 2014年12月16日 22:09
  • 2365

Servlet规范总结

Servlet接口Servlet规范的核心接口即是Servlet接口,它是所有Servlet类必须实现的接口,在Java Servelt API中已经提供了两个抽象类方便开发者实现Servlet类,分...
  • wangyangzhizhou
  • wangyangzhizhou
  • 2016年10月08日 08:49
  • 4305

Spring注解的使用规范

我们经常说的控制翻转(Inversion of Control,IOC)和依赖注入(dependency injection,DI)在Spring环境下是等同的概念,控制翻转是通过依赖注入实现的。所谓...
  • xht555
  • xht555
  • 2016年11月02日 10:36
  • 385

日志输出规范

生产和测试环境中需要日志来记录、跟踪和分析系统的运行状态,但是有太多带有杂讯的日志又会影响跟踪,甚至可能对系统的运行带来影响。 我们需要怎样的日志 可以被记录、跟踪、分析和归档 了解系统运行的必要信息...
  • ggj20ss
  • ggj20ss
  • 2017年02月24日 15:50
  • 556

银联规范汇总

1.移动支付(CUPMobile) 《CUPMobile核心功能规范》、《CUPMobile银行卡应用规范》、《CUPMobile智能SD卡应用接口规范》、《CUPMobile 应用管理终端接口规范...
  • willand1981
  • willand1981
  • 2012年05月18日 15:42
  • 3806
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:规范
举报原因:
原因补充:

(最多只允许输入30个字)