Ada '83 Quality and Style:

Guidelines for Professional Programmers

Copyright 1989, 1991,1992 Software Productivity Consortium, Inc., Herndon, Virginia.

CHAPTER 3: Readability

This chapter recommends ways of using Ada features to make reading and understanding code easier. There are many myths about comments and readability. The responsibility for true readability rests more with naming and code structure than with comments. Having as many comment lines as code lines does not imply readability; it more likely indicates the writer does not understand what is important to communicate.

In this chapter...
3.1 Spelling
3.1.1 Use of Underscores
3.1.2 Numbers
3.1.3 Capitalization
3.1.4 Abbreviations

3.2 Naming Conventions
3.2.1 Names
3.2.2 Type Names
3.2.3 Object Names
3.2.4 Program Unit Names
3.2.5 Constants and Named Numbers

3.3 Comments
3.3.1 General Comments
3.3.2 File Headers
3.3.3 Program Unit Specification Header
3.3.4 Program Unit Body Header
3.3.5 Data Comments
3.3.6 Statement Comments
3.3.7 Marker Comments

3.4 Using Types
3.4.1 Declaring Types
3.4.2 Enumeration Types

Summary
spelling
naming conventions
comments
using types

Back to document index