使用注释在Source Code中记录关注点
Recording Concerns in Source Code Using Annotations
摘要:
一个关注点可以被描述为一段代码背后的开发者的意图,通常没有显式地捕获在其中。我们讨论了一种使用源代码注释(关注点注释)记录关注点的技术。通过两个研究和两个对照实验,我们试图回答以下三个研究问题:1)程序员的心智模型是否重叠?2)当共享关注注释可用时,开发人员如何使用它们?3)使用其他人创建的注释是否可以提高程序的理解和维护的正确性、时间和信心?第一项研究表明,开发人员的心智模型,使用关注注释记录,重叠,因此可以共享。第二项研究表明,共享关注注释可以在程序理解过程中用于以下目的:假设确认,功能定位,获得新的知识,发现关系和维护说明。第一个对照实验表明,注释的存在显着减少了34%的程序理解和维护时间。第二个对照实验是第一个实验的差异化复制,重点是工业开发商。它在正确性方面有33%的显着提高。我们的结论是关注注释是一个可行的方式来分享开发人员的想法。
英文摘要:
A concern can be characterized as a developer's intent behind a piece of code, often not explicitly captured in it. We discuss a technique of recording concerns using source code annotations (concern annotations). Using two studies and two controlled experiments, we seek to answer the following 3 research questions: 1) Do programmers' mental models overlap? 2) How do developers use shared concern annotations when they are available? 3) Does using annotations created by others improve program comprehension and maintenance correctness, time and confidence? The first study shows that developers' mental models, recorded using concern annotations, overlap and thus can be shared. The second study shows that shared concern annotations can be used during program comprehension for the following purposes: hypotheses confirmation, feature location, obtaining new knowledge, finding relationships and maintenance notes. The first controlled experiment with students showed that the presence of annotations significantly reduced program comprehension and maintenance time by 34%. The second controlled experiment was a differentiated replication of the first one, focused on industrial developers. It showed a 33% significant improvement in correctness. We conclude that concern annotations are a viable way to share developers' thoughts.
机构、总结、中文摘要均由AI分析而来,可能存在错误,请以论文正文为准。