The Psychology of Quality and More

C Style: Standards and Guidelines (contents)

CHAPTER 3 : General Principles

PART 1 : BASICS

CHAPTER 3 : General Principles

3.1 Keywords

3.2 Think of the reader

3.3 Keep it simple

3.4 Be explicit

3.5 Be consistent

3.6 Minimize scope

3.7 There's no one true style

3.8 A standard which isn't used, isn't a standard

3.9 Distinguish between standards and guidelines

3.10 Standards don't guarantee good coding

3.11 Decide on your portability quotient

3.12 Standards are a function of their audience

3.13 Keep project standards

3.14 Use standard libraries

3.15 Utilize available tools

3.16 Summary

<--Prev page | Next page -->

3.4 Be explicit

There are a number of occasions when writing a C program where novel features of the language may be used. 'Novel' is defined here as meaning 'unclear to the average reader'. This includes all implicit uses of the language. For example, consider the if statement, where the expression is implicitly compared with zero:

if ( WordCount )

This is using a feature of the language (albeit explicitly defined) in a manner which is not immediately clear. What is really meant is:

if ( WordCount != 0 )

It commonly occurs, as in the above example, that the principle of explicitness is in conflict with the principle of simplicity. In such cases the principle of explicitness usually wins, although common sense should be used in all cases.

A complementary acronym to the KISS principle may be used for the principle of explicitness: the SWYM principle - Say What You Mean.

<--Prev page | Next page -->