skip to main content
article
Free Access

Using literate programming to teach good programming practices

Authors Info & Claims
Published:12 March 1994Publication History
Skip Abstract Section

Abstract

The ability to comprehend a program written by other individuals is becoming increasingly important in software development and maintenance. In an attempt to encourage undergraduate Computer Science students to write informative and usable documentation, the literate programming paradigm was incorporated into the teaching of one undergraduate Computer Science course at Augustana College. This paper describes the concept of literate programming, the experience of using literate programming to teach good programming practices, and the results from the experiment that showed that literate programming encourages more documentation.

References

  1. 1 Avenarius, A. and Oppermann, S., "F'WEB" A Literate Programming System For FORTRAN8x", ACM SIGPLAN Notices, Vol.25, No.l, pp. 52-58, Jan 1990. Google ScholarGoogle ScholarDigital LibraryDigital Library
  2. 2 Brown, M., and Cordes, D., "A Literate Programming Design Language", Prec. CompEuro 90, IEEE International Conf. Computer Systems and Software Engineering, IEEE CS Press, Los Alamitos, Calif., 1990, pp. 548-549.Google ScholarGoogle Scholar
  3. 3 Chapin, N., "Software Maintenance: A Different View", AFIPS Conference Proceeding, 54th National Computer Conference, 1985, pp. 509-513.Google ScholarGoogle Scholar
  4. 4 Fletton N., and Munro, M. "Re.documenting Software Systems Using Hyportext Technology", IEEE Conference on Software Maintenance, 1988, pp. 54-59.Google ScholarGoogle Scholar
  5. 5 Gurari, E. and Wu, J., "A WYSIWYG Literate Programming System {Preliminary Report}",Procee~ings CSC '91, 1991, pp. 94-104. Google ScholarGoogle ScholarDigital LibraryDigital Library
  6. 6 Hyman, M., "Literate C + +", Computer Language, Jul 1990, Vol. 7, No.7, pp. 67-79.Google ScholarGoogle Scholar
  7. 7 Knuth, D. E., "Literate Programming", The Computer Journal, Vol. 27, No. 2, 1984, pp. 97-111. Google ScholarGoogle ScholarDigital LibraryDigital Library
  8. 8 Mmxin, J. and McClure, C., Software Maintenance: The Problem and Its Solutions. Prentice-Hall, 1983. Google ScholarGoogle ScholarDigital LibraryDigital Library
  9. 9 Y. Nakamoto, Y., Iwamoto, T., Hori, M., Ha#ham, K., Tokura, N., "An Editor for Documentation in C-system to Support So f~varc Development and Maintenance", IEEE 6th International Conference on Software Engineering, 1982, pp. 330-339. Google ScholarGoogle ScholarDigital LibraryDigital Library
  10. 10 Reenskaug, T., Skaar A., "An Environment For Literate Smalltalk Programming", OOPSLA 1989 Proceedings, pp. 337-345. Google ScholarGoogle ScholarDigital LibraryDigital Library
  11. 11 Shum, S., Cook, C., "AOPS: An Abstraodon Oriented Programming System For Literate Programming", Software Engineering Journal, Vol. 8 No. 3 (May 1993), pp. 113-120.Google ScholarGoogle ScholarCross RefCross Ref
  12. 12 Standish, T., "An Essay on Software Reuse", IEEE Trans on Software Engineering, Vol.SE-10, No.5, pp. 494-497, Sep 1984.Google ScholarGoogle ScholarDigital LibraryDigital Library
  13. 13 Thimble, by, H., "Experience of 'Literate Programming' Using CWEB {a Variant of Knuth's WEB}", The Computer Journal, Vol. 29, No. 3, 1986, pp. 201-211.Google ScholarGoogle ScholarCross RefCross Ref
  14. 14 Tung, S. H., "A Structured Method For Literate Programming", Structured Programming, 1989, Vol. 10, No. 2, pp. 113-120.Google ScholarGoogle Scholar
  15. 15 Wu,Y. and Baker,T., "A Source Code Documentation System For Aria", ACM Aria Letters, Vol.9, No.5, pp. 84-88, Jul/Aug 1989. Google ScholarGoogle ScholarDigital LibraryDigital Library
  16. 16 Zvegintzov, N., "Nanotrends", Datamation, Aug 1983, pp. 106-116.Google ScholarGoogle Scholar

Index Terms

  1. Using literate programming to teach good programming practices

          Recommendations

          Comments

          Login options

          Check if you have access through your login credentials or your institution to get full access on this article.

          Sign in

          Full Access

          • Published in

            cover image ACM SIGCSE Bulletin
            ACM SIGCSE Bulletin  Volume 26, Issue 1
            March 1994
            410 pages
            ISSN:0097-8418
            DOI:10.1145/191033
            Issue’s Table of Contents
            • cover image ACM Conferences
              SIGCSE '94: Proceedings of the twenty-fifth SIGCSE symposium on Computer science education
              March 1994
              414 pages
              ISBN:0897916468
              DOI:10.1145/191029

            Copyright © 1994 ACM

            Publisher

            Association for Computing Machinery

            New York, NY, United States

            Publication History

            • Published: 12 March 1994

            Check for updates

            Qualifiers

            • article

          PDF Format

          View or Download as a PDF file.

          PDF

          eReader

          View online with eReader.

          eReader
          About Cookies On This Site

          We use cookies to ensure that we give you the best experience on our website.

          Learn more

          Got it!