Interactive and collaborative source code annotation
Interactive and collaborative source code annotation
复制标题
DOI：
--
复制
发表时间：
2015-05
期刊：
影响因子：
--
通讯作者：
Ryo Suzuki
中科院分区：
文献类型：
--
作者：
Ryo Suzuki
在分布式程序员之间共享源代码背后的知识方面，软件文档扮演着重要的角色。好的文档使源代码更容易理解；另一方面，每当源代码发生变化时，开发人员都必须不断更新文档。开发人员将受益于一个自动化工具，该工具可以简化文档的更新并促进协作编辑。本文结合众包思想，探讨了协同代码标注的概念。我们介绍了Cumiki，这是一个基于Web的协作注释工具，它使众多开发人员能够更轻松地协作创建最新的文档。本文描述了用户界面、机制及其实现，并讨论了可能的使用场景。
Software documentation plays an important role in sharing the knowledge behind source code between distributed programmers. Good documentation makes source code easier to understand; on the other hand, developers have to constantly update the documentation whenever the source code changes. Developers will benefit from an automated tool that simplifies keeping documentation up-to-date and facilitates collaborative editing. In this paper, we explore the concept of collaborative code annotation by combining the idea from crowdsourcing. We introduce Cumiki, a web-based collaborative annotation tool that makes it easier for crowds of developers to collaboratively create the up-to-date documentation. This paper describes the user interface, the mechanism, and its implementation, and discusses the possible usage scenarios.