skip to main content
article
Free Access

Typographic style is more than cosmetic

Published:01 May 1990Publication History
Skip Abstract Section

Abstract

There is disagreement about the role and importance of typographic style (source code formatting and commenting) in program comprehension. Results from experiments and opinions in programming style books are mixed. This article presents principles of typographic style consistent and compatible with the results of program comprehension studies. Four experiments demonstrate that the typographic style principles embodied in the book format significantly aid program comprehension and reduce maintenance effort.—Authors' Abstract

References

  1. 1 Adelson, B. Problem solving and the development of abstract categories in programming languages. Mein. Cognition 9, 4 (1981), 422- 433.Google ScholarGoogle ScholarCross RefCross Ref
  2. 2 Baecker, R. Enhancing program readability and comprehensibility with tools for program visualization. In Proceedings of the Tenth International Conference on Software Engineering (Raffles City, Singapore, Apr. 11-15). ACM/SIGSOFT and IEEE/CS, New York, 1988, pp. 356-366. Google ScholarGoogle ScholarDigital LibraryDigital Library
  3. 3 Brooks. R. E. Towards a theory of the comprehension of computer programs. Int. J. of Man-Machine Stud. 18, 6 (June 1983), 543-554.Google ScholarGoogle ScholarCross RefCross Ref
  4. 4 F}eldstad, R. K., and Hamlen, W. T. Applications program maintenance study: Report to our respondents. In Tutorial on Software Maintenance, G. Parikh and N. Zvegintzov, Eds. IEEE/CS Press, Silver Spring, Md., 1983, pp. 13-27.Google ScholarGoogle Scholar
  5. 5 Kernighan, B. W., and Plauger, P. J. The Elements of Prograrnming Style. McGraw-Hii1, New York, 1974. Google ScholarGoogle ScholarDigital LibraryDigital Library
  6. 6 Kernighan, B. W., and Ritchie, D. M. The C Programming Language. Prentice-Hall, Englewood Cliffs, N. }., 1978. Google ScholarGoogle ScholarDigital LibraryDigital Library
  7. 7 Ledgard, H., and Tauer, J. Professional Software, Vol. II Programming Practice. Addison-Wesley, Reading, Mass., 1987. Google ScholarGoogle ScholarDigital LibraryDigital Library
  8. 8 Littman, D., Pinto, J., Letovsky, S., and Soloway, E. Mental models and software maintenance. In Empirical Studies of Programmers. E. Soloway and S. Iyengar, Eds. Ablex Publishing, Norwood N. J., 1986, pp. 8O-98. Google ScholarGoogle Scholar
  9. 9 Lore, T. An experimental investigation of the effect of program structure on program understanding. ACM SIGPLAN Notice 12, 3 (Mar. 1977), 105-113. Google ScholarGoogle ScholarDigital LibraryDigital Library
  10. 10 Miara, R. J., Musselman, J. A., Navarro, I. A., and Shneiderman, B. Program indentation and comprehensibility. Commun. ACM 26, 11 (Nov. 1983), 861-867. Google ScholarGoogle ScholarDigital LibraryDigital Library
  11. 11 Pennington, N. Stimulus structures and mental representations in expert comprehension of computer programs. Cognitive Psychol. 19, 2 (Feb. 1987), 295-341.Google ScholarGoogle ScholarCross RefCross Ref
  12. 12 Oman, P., and Cook, C. R. A taxonomy for programming style. In Proceedings of the Eighteenth Annual Computer Science Conference (Washington D.C., Feb. 22-23.) ACM, New York, 1990, pp. 244-250. Google ScholarGoogle ScholarDigital LibraryDigital Library
  13. 13 Sheil, B. A. The psycho}ogical study of programming. Comput. Surv. 13, 1 (Mar. 1981}, 101-120. Google ScholarGoogle ScholarDigital LibraryDigital Library
  14. 14 Schneider, G., and Buell, S. Advanced Programming and Problem Solving With Pascal. John Wiley & Sons, New York, 1981. Google ScholarGoogle ScholarDigital LibraryDigital Library
  15. 15 Shneiderman, B., and McKay, D. Experimental investigations of computer program debugging and modification. In Software Psychology. Winthrop Puhlishers, Cambridge, Mass., 1980, pp. 72-74.Google ScholarGoogle Scholar
  16. 16 Soloway, E., and Ehrlich, K. Empirical studies of programming knowledge. IEEE Trans. Softw. Eng. SE-IO, 5 (Sept. 1984}, 595-609.Google ScholarGoogle ScholarDigital LibraryDigital Library

Index Terms

  1. Typographic style is more than cosmetic

        Recommendations

        Reviews

        Thomas Plum

        “Book format” for programs includes a table of contents, indexes (various cross-reference lists), chapters containing related procedures and functions, paragraphs separated by blank lines, sentences (horizontal statement-sequences), and font distinctions such as boldface function calls. This paper should interest everyone responsible for presentation of programs or for programming style standards. One vital issue the authors do not address is what technology is proposed to allow convenient updating of “book format” programs. Printing on paper could entail major reprints for minor changes, but online bit-mapped presentation could accommodate their “book format.”

        Access critical reviews of Computing literature here

        Become a reviewer for Computing Reviews.

        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 Communications of the ACM
          Communications of the ACM  Volume 33, Issue 5
          May 1990
          104 pages
          ISSN:0001-0782
          EISSN:1557-7317
          DOI:10.1145/78607
          Issue’s Table of Contents

          Copyright © 1990 ACM

          Permission to make digital or hard copies of all or part of this work for personal or classroom use is granted without fee provided that copies are not made or distributed for profit or commercial advantage and that copies bear this notice and the full citation on the first page. Copyrights for components of this work owned by others than ACM must be honored. Abstracting with credit is permitted. To copy otherwise, or republish, to post on servers or to redistribute to lists, requires prior specific permission and/or a fee. Request permissions from [email protected]

          Publisher

          Association for Computing Machinery

          New York, NY, United States

          Publication History

          • Published: 1 May 1990

          Permissions

          Request permissions about this article.

          Request Permissions

          Check for updates

          Qualifiers

          • article

        PDF Format

        View or Download as a PDF file.

        PDF

        eReader

        View online with eReader.

        eReader