index

means: orthography

Distinguished orthography is the art of making items stand apart from each other. In prose it usually denotes respect ("Herr Dr Professor") or uniqueness ("IBM", "NASA"); code is the same.

!

//!kludge! fix this.

right-justify

//------------------------------ 
//                 SteeringWheel 
class SteeringWheel { 
//... 
//... 
};

CamelCase

punctuation

Capitalization

ALL CAPS

const int DIFF = 3; 
code(); 
code = code*code + (code() ? code : code); 
codeCode(); 
if (code==DIFF) return; 
codeCodeCode();

Sometimes Reader just wants to go on cruise control.

ALL_CAPS is such a weird powerful thing, we can't ignore.

#MACROS

Preprocessor defines. Such weird things. Mark them.

#define RPT(n,msg) {if(n<=nw::verbose)				\ 
      {cerr<<'['<<__FILE__<<','<<__LINE__<<"]\t"<<NWID<<':'<<msg<<endl;}} 

{ 
  RPT(3, "start loop"); 
  //... 
}

local automatics

vector TEMP(99,0); 
//...

Highlight its very temporariness.

the odd variable set

doub X,Y,Z;

Highlight its uniqueness.

princesses

class Princess { 
//... 
}; 

Princess ANASTASIA, ELIZABETH, CLEOPATRA; // they hate each other.

Keep the customers happy, they love the attention.

nedwaves.com 2017 [171108]