sourcemointor评价代码

0 前言

Source Monitor是一款免费的代码品质度量软件。合理地利用这个工具&＃xff0c;可以在一定程度上提高自己代码可读性、可维护性&＃xff0c;进而提高代码品质。个人理解的话&＃xff0c;使用sourcemonitor工具能够更加直观的看到代码的质量&＃xff0c;比如圈复杂度&＃xff0c;重构的迫切程度等。本文以java代码为例&＃xff0c;主要记录在单元测试过程中使用sourcemonitor评价代码质量。本文中使用到的源代码在这篇文章可见

1 流程操作

1、选择语言种类

2、为项目设置名称以及设置项目存放的位置

3、选择需要分析的java代码所在文件

4、一路点击下一步直到下面的界面

5、右边的所有文件就是即将分析的代码&＃xff0c;如果有你不需要的就双击对应的文件&＃xff0c;不被分析的文件就会放在页面左边。

6、点击ok

2 评价名词

首先查看各个字段代表含义

• 总行数(Lines)&＃xff1a;包括空行在内的代码行数&＃xff1b;

• 语句数目(Statements)&＃xff1a;在java语言中&＃xff0c;语句是以分号结尾的。分支语句if&＃xff0c;循环语句for、while&＃xff0c;跳转语句goto都被计算在内&＃xff0c;预处理语句#include、#define和#undef也被计算在内&＃xff0c;对其他的预处理语句则不作计算&＃xff0c;在#else和#endif、#elif和#endif之间的语句将被忽略&＃xff1b;

• 分支语句比例(Percent Branch Statements)&＃xff1a;该值表示分支语句占语句数目的比例&＃xff0c;这里的“分支语句”指的是使程序不顺序执行的语句&＃xff0c;包括if、else、for、while和switch&＃xff1b;

• 注释比例(Percent Lines with Comments)&＃xff1a;该值指示注释行&＃xff08;包括/……/和//……形式的注释&＃xff09;占总行数的比例&＃xff1b;

• 函数数目(Functions)&＃xff1a;指示函数的数量&＃xff1b;

• 平均每个函数包含的语句数目(Average Statements per Function)&＃xff1a;总的函数语句数目除以函数数目得到该值&＃xff1b;

• 函数圈复杂度(Function Complexity)&＃xff1a;圈复杂度指示一个函数可执行路径的数目&＃xff0c;以下语句为圈复杂度的值贡献1&＃xff1a;if/else/for/while语句&＃xff0c;三元运算符语句&＃xff0c;if/for/while判断条件中的"&&"或“||”&＃xff0c;switch语句&＃xff0c;后接break/goto/ return/throw/continue语句的case语句&＃xff0c;catch/except语句&＃xff1b;

• 函数深度(Block Depth)&＃xff1a;函数深度指示函数中分支嵌套的层数。

• Maximum Complexity&＃xff1a;该类中最复杂函数的复杂度

有了以上名词我们再看sourcemonitor中各个视图

3 具体信息

3.1 java文件详细视图

比如这里我们查看PeopleTestParameterized.java文件的评价信息

Lines:该类总共有100行代码&＃xff0c;包括空行
Statements&＃xff1a;其中有58行是有效的代码
Branch&＃xff1a;其中有0行分支语句
Method call statements&＃xff1a;函数调用语句有8行。
Percent lines with comment:指的是语句中注释所占的比例5%
classess and Interfaces&＃xff1a; 该文件中所包含的类和接口的总数量为1
Methonds per Class:平均每个类中有6个方法。
Average Statements per Method : 平均每个方法中有6.17行语句
Line Number of Most Complex Method:其中最复杂的函数有25行代码
Name of Most Complex Method:其中最复杂的函数名字为&＃xff1a;data().testGetAllPrice()。
&＃xff08;还有很多信息都比较直白&＃xff0c;这里不做过多介绍&＃xff0c;直接看英文对应value即可明白什么意思了&＃xff0c;这里主要介绍两张图&＃xff09;

雷达图&＃xff1a;该图主要采用直观的方式表示该文件的代码的重构急迫性。当红色的圈在绿色圈以内时代码不需要重构&＃xff0c;表示代码在安全范围内。但当红色圈在绿色圈意外时&＃xff0c;代表代码急需重构。
三维柱状图&＃xff1a;形描述语句长度与深度之间关系。

3.2 检查点视图

能够查看所有java文件的详细信息&＃xff0c;关键字含义如上文所示。

3.3 函数视图

函数视图是检查点视图的进一步划分&＃xff0c;所描述的信息也更加详细。

3.4 函数复杂度与频率视图

该视图中横坐标为复杂度&＃xff0c;纵坐标为出现次数。该视图主要描述的是本次测定所有代码中&＃xff0c;所有函数复杂度与出现次数的统计信息视图。