Get 20M+ Full-Text Papers For Less Than $1.50/day. Start a 14-Day Trial for You or Your Team.

Learn More →

A source code documentation system for Ada

A source code documentation system for Ada A Source Code Documentation System For Ad a Y .C . Wu and T .P . Baker ' Department of Computer Scienc e Florida State Universit y Tallahassee, Florida 3230 4 1 . Introduction . This paper presents a first step toward a high-quality source code documentation syste m for Ada . The system is an adaptation of Web 2 , a system of structured documentation created as a part o f the TEX project by Professor Donald E . Knuth [1-3] at Stanford University . The chief virtues of the Web system are that it encourages consistency between code and documentatio n and it supports the production of high-quality typeset documentation in a uniform style . With Web th e source code and documentation of a program are combined in a single file . There are two programs, Weav e and Tangle, which produce Tl typesetting commands and compilable source code, respectively, from th e Web file . Since Tangle automatically organizes the code fragments into a compilable order as it extract s them from the Web file, the author is freed of syntactic constraints imposed by the programming language , and can structure the Web file http://www.deepdyve.com/assets/images/DeepDyve-Logo-lg.png ACM SIGAda Ada Letters Association for Computing Machinery

A source code documentation system for Ada

Wu, Y. C.; Baker, T. P.
ACM SIGAda Ada Letters , Volume IX (5) – Jul 1, 1989
Download PDF
5 pages

Loading next page...
 
/lp/association-for-computing-machinery/a-source-code-documentation-system-for-ada-0WvNwbX9do

References

References for this paper are not available at this time. We will be adding them shortly, thank you for your patience.

Publisher
Association for Computing Machinery
Copyright
Copyright © 1989 by ACM Inc.
ISSN
1094-3641
DOI
10.1145/71340.71344
Publisher site
See Article on Publisher Site

Abstract

A Source Code Documentation System For Ad a Y .C . Wu and T .P . Baker ' Department of Computer Scienc e Florida State Universit y Tallahassee, Florida 3230 4 1 . Introduction . This paper presents a first step toward a high-quality source code documentation syste m for Ada . The system is an adaptation of Web 2 , a system of structured documentation created as a part o f the TEX project by Professor Donald E . Knuth [1-3] at Stanford University . The chief virtues of the Web system are that it encourages consistency between code and documentatio n and it supports the production of high-quality typeset documentation in a uniform style . With Web th e source code and documentation of a program are combined in a single file . There are two programs, Weav e and Tangle, which produce Tl typesetting commands and compilable source code, respectively, from th e Web file . Since Tangle automatically organizes the code fragments into a compilable order as it extract s them from the Web file, the author is freed of syntactic constraints imposed by the programming language , and can structure the Web file

Journal

ACM SIGAda Ada Letters – Association for Computing Machinery

Published: Jul 1, 1989

There are no references for this article.