JTourBus: Simplifying Program Understanding by Documentation that Provides Tours Through the Source Code

JTourBus: Simplifying Program Understanding by Documentation that Provides Tours Through the Source Code
复制标题

JTourBus:通过源代码提供游览的文档简化程序理解

DOI:
10.1109/icsm.2007.4362619
复制
发表时间:
2007
期刊:
2007 IEEE International Conference on Software Maintenance
影响因子:
--
通讯作者:
L. Prechelt
L. Prechelt
中科院分区:
--
文献类型:
--
作者:
C. Oezbek;L. Prechelt

文献摘要

参考文献

被引文献

相似文献

许多中小型系统很少或根本没有设计文档,这使得由外部人员执行维护期间的程序理解变得非常困难。因此,如果只有最少的设计文档可用,那么应该采取哪种形式来最大限度地发挥其效用?我们建议,如果文档描述了源代码之旅,将用户直接引导到相关的细节,这将是很有帮助的。这项工作报告的评价,这一概念的想法,在一个控制实验的形式与59名学生受试者的工作在一个困难的程序理解任务的上下文中的27 KNOWJHotDraw图形框架。一组收到纯文本文档,另一组收到tour结构的文档,他们使用我们为实验构建的名为JTourBus的Eclipse插件进行导航。结果表明,与纯文本文档相比,使用JTourBus可以更快地实现程序理解(尽管不是更正确)。
Many small and medium-sized systems have little or no design documentation, which makes program understanding during maintenance enormously more difficult when performed by outsiders. Thus, if only minimal design documentation is available, which form should it take to maximize its usefulness? We suggest that it is helpful if the documentation describes a tour through the source code, leading the user directly to relevant details. This work reports an evaluation of this conceptual idea in the form of a controlled experiment with 59 student subjects working on a difficult program understanding task in the context of the 27 KLOC JHotDraw graphics framework. One group received a plain text documentation, the other received tour-structured documentation which they navigated by using an Eclipse plugin called JTourBus that we constructed for the experiment. The results indicate that program understanding can be achieved somewhat faster (albeit not more correctly) with JTourBus than with a plain text document.
DOI: 10.1007/bfb0053381
发表时间: 1997-01-01
期刊: ECOOP'97: OBJECT-ORIENTED PROGRAMMING
影响因子: --
作者:
Kiczales, G;Lamping, J;Irwin, J
通讯作者: Irwin, J