Naming convension

Constant and variable naming conventions

It is considered good programming practice to name constants and variables with meaningful names. In order to augment the purpose of each constant or variable with its data type and even to know whether it's a constant or a variable without haveing to stop and check each one, a general naming convention is followed, as shown in the table below.

Starts with Example Means it is a Located in

c cFlags_nRF CHAR variable SRAM

csz csz CHAR ASCIIz string variable SRAM

b bFlags_nRF BYTE variable SRAM

w wAnalogInput0 WORD variable SRAM

ul ulRandomValue1 UNSIGNED LONG variable SRAM

bPtr bPtrNextOp> pointer to a BYTE variable SRAM

wPtr wPtrDest pointer to a WORD variable SRAM

sz szBuffer pointer to an ASCIIz buffer SRAM

s sWallClock STRUCTURE variable SRAM

u uVars UNION variable SRAM

EEb EEbSystemMode BYTE variable EEPROM

EEw EEwCOM1_xBPS WORD variable EEPROM

EEptr EEptrSeqConfig pointer to an SRAM variable EEPROM

EEfptr EEfptrSequence1 pointer to a FLASH variable EEPROM

CSZ CSZ_MasterPW CHAR ASCIIz constant string FLASH

A ACSZ_Version constant Address of a variable or constant -

SI SI_nRFStatus Structure Index constant -

BIT BIT_RTC_ENABLE BIT constant defined within a BYTE -

- DISCRETE_INPUT_1 constant -

Starts with	Example	Means it is a	Located in
c	cFlags_nRF	CHAR variable	SRAM
csz	csz	CHAR ASCIIz string variable	SRAM
b	bFlags_nRF	BYTE variable	SRAM
w	wAnalogInput0	WORD variable	SRAM
ul	ulRandomValue1	UNSIGNED LONG variable	SRAM
bPtr	bPtrNextOp>	pointer to a BYTE variable	SRAM
wPtr	wPtrDest	pointer to a WORD variable	SRAM
sz	szBuffer	pointer to an ASCIIz buffer	SRAM
s	sWallClock	STRUCTURE variable	SRAM
u	uVars	UNION variable	SRAM
EEb	EEbSystemMode	BYTE variable	EEPROM
EEw	EEwCOM1_xBPS	WORD variable	EEPROM
EEptr	EEptrSeqConfig	pointer to an SRAM variable	EEPROM
EEfptr	EEfptrSequence1	pointer to a FLASH variable	EEPROM
CSZ	CSZ_MasterPW	CHAR ASCIIz constant string	FLASH
A	ACSZ_Version	constant Address of a variable or constant	-
SI	SI_nRFStatus	Structure Index constant	-
BIT	BIT_RTC_ENABLE	BIT constant defined within a BYTE	-
-	DISCRETE_INPUT_1	constant	-

Additional notes:
CHAR means a SIGNED 8-bit variable or constant
BYTE means UNSIGNED CHAR (8 bits)
INT means a SIGNED 16-bit variable or constant
WORD means UNSIGNED SHORT INT (16 bits)
LONG means SIGNED LONG INT (32 bits)
ASCIIz means an NULL-terminated ASCII character string
Pointers are 16-bit addresses to locations in SRAM, EEPROM or FLASH memory
Names that are all uppercase generally refer to a constant or data type.
"Sentence" means 16 BYTEs.
"Paragraph" means 256 (= 0x100) BYTEs.