张张张z

博客园 首页 新随笔 联系 订阅 管理

 

  由于之前我们小组在一起开会,大体上学习了被测系统的运行流程,大家有还算比较了解这个系统了,

在这基础上,我们又继续召开评审会议。首先主持人让大家仔细阅读学习代码评审标准文档,然后我们才开

始,通过静态评审发现代码中缺陷,并对评审结果做了详细的记录。

  同时在评审完成后,我们小组组长带领大家对之前工作进行了小结,还有对发现的问题提出改正方法。

如下展示的是代码规范要求:

写干净整洁的代码

a .代码格式化,包括多级代码缩进、大括号(比如C系代码),为了提高代码的美观型和易读性,区间与区间之间最好以一行*或-之类的间距;

b.合理运用空行。空行可以用来隔开相对独立的代码块,有利于阅读和理解。但是不要使用超过一行的空行,对空间,别太奢侈了;

 

命名规范

命名包括函数、变量、类(面向对象中)、命名空间等;

a.命名需要遵循由其命名便知道其意义的原则;

变量命名区分全局变量、导出变量、常量、局部变量,最好区分类型(如果有的话);

b. 可采用业界的一些命名规范,比如匈牙利命名,但同一个项目必须统一;

 

高效使用注释

 a.注释代码段,注释逻辑选择。上面提到运用空行分割开逻辑相对独立的代码,那么请在空行的下一行也写点下面代码段要干什么的语句吧。如果有if else等逻辑选择的时候,麻烦也花几秒钟写上判断的依据和结果好吗?逻辑难懂且关键,您懂的!

b. 为不容易理解类变量注释。类变量特别是私有的类变量没有人要求注释,但是为了能够快速的了解您表示的是什么,还是写点什么吧!您知道我英文不算好!

c. 独立的代码模块、文件、函数需要撰写注释以说明其实现意图、原理、怎么使用等(比如函数的输入输出参数等),独立的代码文件和模块(比如类)最好写上作者、日期、联系方式、版本号等信息,以便后期做追踪;

d.并不是注释越多越好,相反,完全模块化、结构化的程序很多地方注释完全可以精简;

 

程序结构化、模块化

a.程序设计中有很多原则、设计模式,不同的语言、不同的情景可能会有些差异,但整体需要支持高类聚、低耦合的设计实现方案;

 

posted on 2017-12-20 23:04  1707-01  阅读(138)  评论(0编辑  收藏  举报