Toward efficient source code sharing on the Web

Title: Toward efficient source code sharing on the Web

Authors: Hiroaki Fukuda (Shibura Institute of Technology, Japan)

Abstract: The Web is one of the useful references for developers to find pieces of code that represent what they need nowadays. In addition, we can find websites that contain not only source code but also detailed explanations of the code. In these websites, explanations are usually located above/below code, thereby users, who refer to these explanations, sometimes need to scroll a (browser) window to understand pieces of code reading the corresponding explanations. As a consequence, users have to temporarily memorize code and/or the corresponding expositions, wasting extra time. On the other hand, it is common to use wiki to edit a set of code and corresponding explanations. In most wiki systems, they prepare only one window to edit code and its explanations, therefore editors usually need to scroll the window to complete editing, also consuming extra time. This paper proposes a special wiki system for reading and editing source code referring its explanations, called CodeWiki that provides multiple windows for editors to edit code and explanations. Besides, CodeWiki enables readers to click a link which will lead them to a window that contains corresponding explanations. As a consequence, readers and editors do not need to scroll a window, meaning that CodeWiki can prevent readers/editors from wasting extra time. We propose a prototype implementation of CodeWiki and show its usage.

This contribution to OpenSym 2015 will be made available as part of the OpenSym 2015 proceedings (or companion) on or after August 19, 2015.

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.