WCSE

CodeWiki: Toward Efficient Source Code Sharing on the Web

Abstract— Nowadays most of developers can find some useful references of source code on the website. Moreover, those source codes come with their explanations which usually located above or below the code. When the code is too long to fit within one page, the explanation will be inconsistently corresponding with the code because users have to scroll the page for comprehending both codes and explanations. As a consequence, users have to wasted extra time to conjugate the pieces of code with their explanations. In addition, most of wiki systems provide only single area to edit both code and explanation which also consuming the time for writing a good explanation for each section of the code. This paper offers a specific type of wiki system with provided parallel area for reading and editing source code, called CodeWiki. Besides, Codewiki allows readers to click on each section of the code for its in-line explanations. Consequently, readers and editors do not waste their time on scrolling the page and enable the correspondent between the source code and its explanation. We propose a prototype implementation of CodeWiki and the result of its usage.

Index Terms— Wikis, corresponding reading and editing, source code sharing

Hiroaki Fukuda, Worachat Arunothaikrit, Maylada Kanokchoteworakarn
Shibaura Institute of Technology, Japan

[Download]

Cite: Hiroaki Fukuda, Worachat Arunothaikrit, Maylada Kanokchoteworakarn, "CodeWiki: Toward Efficient Source Code Sharing on the Web," Proceedings of 2018 the 8th International Workshop on Computer Science and Engineering, pp. 678-684, Bangkok, 28-30 June, 2018.