Overview

Naming functions and variables might seem trivial but good function and variable names are a sign of superior programs. When creating names for variables and functions (identifiers), it is often the practice to use acronyms (e.g., OS, ISR, TCB), abbreviations (buf, doc, etc.), and mnemonics (clr, cmp, etc.). The use of acronyms, abbreviations, and mnemonics allows an identifier to be descriptive while requiring fewer characters. Unfortunately, if acronyms, abbreviations, and mnemonics are not used consistently, they may add confusion. To ensure consistency, I created a list of acronyms, abbreviations, and mnemonics that I use in all my projects. Once assigned, the same acronym, abbreviation, or mnemonic is used consistently. I call this list the Acronym, Abbreviation, and Mnemonic Dictionary. As I need more acronyms, abbreviations, or mnemonics, I simply add them to the list.

Table C.1 shows the acronyms, abbreviations, and mnemonics dictionary that I used for this book. Note that some of the words are the same in both columns. This is done to indicate that there is no acronym, abbreviation, or mnemonic which would better describe the word on the left. A shaded entry in Table C.1 indicates that an acronym, abbreviation, or mnemonic has been used.