Elucidative Programming in open integrated development environments for Java

In this paper we present an integration of tool support for internal documentation in the modern IDE Together J. The specific kind of internal documentation stems from the Elucidative Programming tradition where documentation and source code are separate entities tied together using hyperlinks. The tool supports the programmer in creating and managing internal documentation of Java source code. The hypertext-based documentation is presented in the IDE where a range of navigational features helps the programmer with finding relevant documentation for a given part of the source code. It is concluded that integration of such a tool is indeed possible as well as easy to do in an open IDE like TogetherJ. We expect that we can obtain similar results using other open IDEs.

[1]  Thomas Vestdam Introducing Elucidative Programming in Student Projects , 2001 .

[2]  Patrice Frison,et al.  Software engineering teaching: a “Docware” approach , 1999, ITiCSE '99.

[3]  Richard M. Stallman,et al.  Gnu Emacs Manual , 1996 .

[4]  Kurt Nørmark,et al.  Elucidative programming in Java , 2000, SIGDOC.

[5]  Kurt Nørmark,et al.  Elucidative Programming , 2000, Nord. J. Comput..

[6]  Hausi A. Müller,et al.  Cognitive design elements to support the construction of a mental model during software visualization , 1997, Proceedings Fifth International Workshop on Program Comprehension. IWPC'97.

[8]  R. Stallman EMACS the extensible, customizable self-documenting display editor , 1981, SIGPLAN SIGOA Symposium on Text Manipulation.

[9]  Lisa Friendly,et al.  The Design of Distributed Hyperlinked Programming Documentation , 1995, IWHD.

[10]  Johannes Sametinger,et al.  A hypertext system for literate C++ programming , 1992 .

[11]  Timothy Lethbridge,et al.  The relevance of software documentation, tools and technologies: a survey , 2002, DocEng '02.

[12]  Kurt Nørmark,et al.  Aspects of internal program documentation-an elucidative perspective , 2002, Proceedings 10th International Workshop on Program Comprehension.

[13]  Donald E. Knuth,et al.  The CWEB system of structured documentation - version 3.0 , 1994 .

[14]  Kurt Nørmark,et al.  Requirements for an elucidative programming environment , 2000, Proceedings IWPC 2000. 8th International Workshop on Program Comprehension.

[15]  Kasper Østerbye Literate Smalltalk Programming Using Hypertext , 1995, IEEE Trans. Software Eng..

[16]  Thomas Vestdam Elucidative Program Tutorials , 2002, Nord. J. Comput..

[17]  Donald E. Knuth,et al.  Literate Programming , 1984, Comput. J..