Browse Prior Art Database

Providing Hypertext Links to Code

IP.com Disclosure Number: IPCOM000114389D
Original Publication Date: 1994-Dec-01
Included in the Prior Art Database: 2005-Mar-28
Document File: 4 page(s) / 89K

Publishing Venue

IBM

Related People

Kelly, JA: AUTHOR

Abstract

In order to make source code readable and therefore more maintainable, comments are often included within the code. Unfortunately, adding too many comments to a piece of software may itself raise problems of readability.

This text was extracted from an ASCII text file.
This is the abbreviated version, containing approximately 57% of the total text.

Providing Hypertext Links to Code

      In order to make source code readable and therefore more
maintainable, comments are often included within the code.
Unfortunately, adding too many comments to a piece of software may
itself raise problems of readability.

      By providing software with hypertext links using a simple
pre-processor, comments can be separated from the code while still
permitting inline access to them.

      The example below uses the OS/2* Information Presentation
Facility Compiler (IPFC).  This does not limit its application to
code written for OS/2.  It is simple to download host source code and
apply the same methodology.

      OS/2 IPFC allows one or more source files, containing text and
simple formatting tags, to be transformed into a softcopy book
displayable on the OS/2 operating system using the VIEW command.

Each tag in the file can have an associated TagId, or identifier.

      Using this TagId, in conjunction with some other tags, one can
make hypertext links between sections of text.

      For different types of code there may be different keypoints.
These are point of interest in the code to which an external
reference may be required.
  Examples of keypoints are:  The process includes the following
steps:
  1.  Provide a file containing source code.  For example, CODE.C
  2.  Provide a Parser program to scan the source code file looking
for
       keypoints.  When a keypoint is discovered, modi...