Skip to main content

Rationale for Comments: The Effect on Programming Languages and Implementation

  • Chapter
Empirical Foundations of Information and Software Science

Abstract

Comments in programming languages have traditionally been used to add extra descriptive information to program source code in an informal manner; programmers have been encouraged to use commenting only as a means of creating readable code and specific code documentation. However, research currently being carried out indicates a dramatic change in the importance of comments within programs. This paper describes the changing role of comments, giving examples of new uses of program comments in the area of formal system specification and verification. The relative unimportance which language designers and implementors have associated with a comment facility is highlighted; the need for different types of comments and their syntactical representation is outlined. An increasing awareness of the power of software tools has lead to integrated programming environments which support the manipulation of source code and possibly its intermediate forms. This approach provides a base for tools to act upon comments in a functional way. Proposals are made which are intended to promote discussion on language design, implementation, and internal representation.

This is a preview of subscription content, log in via an institution to check access.

Access this chapter

eBook
USD 16.99
Price excludes VAT (USA)
  • Available as EPUB and PDF
  • Read on any device
  • Instant download
  • Own it forever
Softcover Book
USD 54.99
Price excludes VAT (USA)
  • Compact, lightweight edition
  • Dispatched in 3 to 5 business days
  • Free shipping worldwide - see info

Tax calculation will be finalised at checkout

Purchases are for personal use only

Institutional subscriptions

Preview

Unable to display preview. Download preview PDF.

Unable to display preview. Download preview PDF.

References

  1. R. S. Scowen and B. A. Wichmann, The definition of comments in programming languages,Software — Practice and Experience, 1974,4, pp. 1812–188

    Article  Google Scholar 

  2. NEDP,NEDP Standards Program FORTRAN Programming Standards, Coopers and Lybrand, New York, 1979.

    Google Scholar 

  3. G. H. Okimoto, The Effectiveness of Comments: A Pilot Study, TR 01.1347, IBM SSD Technical Report, July 27, 1970

    Google Scholar 

  4. I. C. Pyle,A Package for Specifying Ada Programs, Computing Service, University of York, October 11, 1983.

    Google Scholar 

  5. A. Burns, Enhanced input/output on Pascal,ACM SIGPLAN Notices, November 1983,18(11), pp. 24 - 33

    Article  Google Scholar 

  6. A. Burns and I. W. Morrison, A comparison of the UNIX and APSE approaches to software tools,Proceedings of the EUUG Conference in Nijmegen, April 16, 1984.

    Google Scholar 

  7. A. Burns and J. Robinson,The Specification of Interactive Ada Programs, CCR43, Department of Computer Science, University of Bradford, UK, January 1, 1984.

    Google Scholar 

  8. G. Goos, W.A Wulf, eds.,DIANA Reference Manual, Institut Fuer Informatik, University of Kalsruhe, 1981.

    Google Scholar 

  9. I. W. Morrison,The Need for Comments in an Internal Representation of Ada, CCR51, Department of Computer Science, University of Bradford, UK, May 1984.

    Google Scholar 

  10. B. Krieg-Brucker and D. C. Luckham, ANNA: towards a language for annotating Ada programs,Proc. ACM, SIGPLAN Symposium on the Ada Programming Languages, ACM SIGPLAN Notices, November 1980,15(11), pp. 128 - 138.

    Article  Google Scholar 

  11. D. A. Fisher, DoD’s common programming language effort,Computer, March 1978, pp. 25–33.

    Google Scholar 

  12. T. Winograd, Beyond programming languages,CACM, July 1979,22(7), pp. 391 - 400

    Google Scholar 

  13. G. B. Bleazard,Program Design Methods, National Computing Centre, 1976.

    Google Scholar 

  14. B. Liskov, et al., CLU reference manual,Lecture Notes in Computer Science No.114, G. Goos and J. Harmanis, eds., Springer-Verlag, 1981

    Google Scholar 

  15. W. Wulf, R. L. London, and M. Shaw, An introduction to the construction and verification of ALPHARD programs,IEEE Trans. Software Engineering, 1976,SE-2 (4), pp. 253–265.

    Article  Google Scholar 

  16. B. W. Lampson, et al., Report on the programming language Euclid,ACM SIGPLAN Notices, 1977,12(2), pp. 1–79

    Article  Google Scholar 

  17. A. Ambler, et al., GYPSY: a language for specification,ACM SIGPLAN Notices, March 1977,12(3), pp. 1–10.

    Article  Google Scholar 

  18. G. J. Popek, et al., Notes on the design of Euclid,ACM SIGPLAN Notices, March 1977,12(3), pp. 1–10.

    Article  Google Scholar 

  19. A. Hill, Towards an Ada-based specification and design language,Ada UK News, October 1984,4(4), pp. 16–32.

    Google Scholar 

  20. D. Bjorner and C. B. Jones, The Vienna development method: the Meta language,Lecture Notes in Computer Science No.61, G. Goos and J. Hartmanis, eds., Berlin, Springer-Verlag, 1978.

    Google Scholar 

  21. A. D. Hill, Asphodel — an Ada compatible specification and design language,Proceedings of the Third Ada-Europe/AdaTec Conference in Brussels, June 26–28, 1984.

    Google Scholar 

  22. S. J. Goldsack and T. Moreton, Ada package specifications: Path Expressions and Monitors,IEEE Proc., March 1982,E-129 (2), pp. 49–54.

    Google Scholar 

Download references

Author information

Authors and Affiliations

Authors

Editor information

Editors and Affiliations

Rights and permissions

Reprints and permissions

Copyright information

© 1985 Springer-Verlag US

About this chapter

Cite this chapter

Morrison, I.W., Burns, A., Robinson, J. (1985). Rationale for Comments: The Effect on Programming Languages and Implementation. In: Agrawal, J.C., Zunde, P. (eds) Empirical Foundations of Information and Software Science. Springer, Boston, MA. https://doi.org/10.1007/978-1-4613-2521-5_17

Download citation

  • DOI: https://doi.org/10.1007/978-1-4613-2521-5_17

  • Publisher Name: Springer, Boston, MA

  • Print ISBN: 978-1-4612-9523-5

  • Online ISBN: 978-1-4613-2521-5

  • eBook Packages: Springer Book Archive

Publish with us

Policies and ethics