Documenting Implementation Decisions with Code Annotations
Documenting Implementation Decisions with Code Annotations
复制标题
使用代码注释记录实施决策
DOI：
--
复制
发表时间：
2015
期刊：
影响因子：
--
通讯作者：
B. Brügge
中科院分区：
文献类型：
--
作者：
Tom;Arthur Kühlwein;B. Paech;T. Roehm;B. Brügge
软件开发人员在实施软件时会做出各种决策。例如，他们决定如何最有效地实现算法或以哪种处理用户输入的方式来实现算法。当在维护过程中重新审视代码时，需要理解基本决定，并可能适应当前情况。诸如Javadoc之类的常见文档方法既没有明确涵盖与决策有关的知识，也不会与知识管理紧密融合。因此，很少有决策知识的记录，因此无法访问，尤其是当开发人员离开团队时。因此，有效维护受到阻碍。我们已经开发了一个用于决策知识的注释模型，并将其与知识管理工具Unicase集成在一起。该方法使开发人员能够在没有工具切换的情况下记录代码中的决策，以降低其文档工作。之后，维护者可以利用嵌入式决策知识并遵循与外部知识的联系。本文介绍了第一个案例研究的方法和评估结果，该结果表明其可实用性。
Software developers make various decisions when implementing software. For instance, they decide on how to implement an algorithm most efficiently or in which way to process user input. When code is revisited during maintenance, the underlying decisions need to be understood and possibly adjusted to the current situation. Common documentation approaches like JavaDoc neither cover knowledge related to decisions explicitly, nor are they integrated closely with knowledge management. In consequence, decision knowledge is rarely documented and therefore inaccessible, especially when developers have left the team. So, effective maintenance is hindered. We have developed an annotation model for decision knowledge and integrated it with the knowledge management tool UNICASE. The approach enables developers to document decisions within code without tool switches to lower their documentation effort. Afterwards, maintainers can exploit the embedded decision knowledge and follow links to external knowledge. This paper presents the approach and evaluation results of a first case study, which indicate its practicability.