[论文解读] Visualizing Object-oriented Software for Understanding and Documentation

Ra’Fat Al-Msie’deen|arXiv (Cornell University)|Jan 28, 2016

Software Engineering Research参考文献 36被引用 12

一句话总结

本文提出了一种面向面向对象软件的自动化可视化方法，通过将代码依赖关系、类关系、包结构以及软件度量整合到交互式图表中，有效提升对系统的理解与文档化水平。该方法通过映射结构性和量化代码特征，实现对系统的有效文档化，案例研究证实其能够准确且全面地表示系统。

ABSTRACT

Understanding or comprehending source code is one of the core activities of software engineering. Understanding object-oriented source code is essential and required when a programmer maintains, migrates, reuses, documents or enhances source code. The source code that is not comprehended cannot be changed. The comprehension of object-oriented source code is a difficult problem solving process. In order to document object-oriented software system there are needs to understand its source code. To do so, it is necessary to mine source code dependencies in addition to quantitative information in source code such as the number of classes. This paper proposes an automatic approach, which aims to document object-oriented software by visualizing its source code. The design of the object-oriented source code and its main characteristics are represented in the visualization. Package content, class information, relationships between classes, dependencies between methods and software metrics is displayed. The extracted views are very helpful to understand and document the object-oriented software. The novelty of this approach is the exploiting of code dependencies and quantitative information in source code to document object-oriented software efficiently by means of a set of graphs. To validate the approach, it has been applied to several case studies. The results of this evaluation showed that most of the object-oriented software systems have been documented correctly.

研究动机与目标

• 为解决在维护、重用或增强过程中理解复杂面向对象软件系统所面临的挑战。
• 通过提取并可视化结构性和量化代码特征，改善软件文档化。
• 通过将低层次代码转换为直观的图形表示，减轻逆向工程的认知负担。
• 通过自动化的、依赖感知的可视化模型，实现对软件架构的高效分析。
• 通过真实世界案例研究验证该方法的实用性。

提出的方法

• 该方法从源代码中提取包结构、类继承层次、方法级依赖关系以及类数量、耦合度等软件度量。
• 构建多个相互关联的图表，以可视化类、包和方法之间的关系。
• 可视化集成静态结构性信息与量化度量，实现对系统的整体性表示。
• 系统采用基于图的渲染技术，展示继承、关联、依赖和方法调用关系。
• 该方法支持对代码结构的交互式探索，有助于导航与理解。
• 该方法被实现为一个自动化处理管道，接收源代码并生成可视化文档。

实验结果

研究问题

• RQ1 如何有效结合代码依赖关系与结构性度量，以提升对软件的理解？
• RQ2 自动化可视化能否减少文档化面向对象系统所需的工作量？
• RQ3 代码结构的可视化表示在多大程度上提升了对复杂系统的理解？
• RQ4 所提出方法在多大程度上能准确重构现实世界软件系统的架构？
• RQ5 软件度量在提升代码可视化清晰度与实用性方面发挥什么作用？

主要发现

• 该可视化方法通过将依赖关系、关系和度量整合到连贯的图形视图中，成功实现了对面向对象软件系统的文档化。
• 案例研究显示，大多数软件系统得到了准确表示，证实了该方法的可靠性。
• 引入软件度量显著提升了可视化结果的可解释性，超越了基本的结构图。
• 该方法在捕捉关键架构特征（如包内容和类间依赖）方面表现有效。
• 结果表明，自动化可视化显著支持了软件理解与文档化任务。
• 该方法通过提供对代码库的即时、结构化视觉洞察，减少了手动逆向工程的工作量。