What's in a Name?

Choose names which are easy to say:

Avoid names which are awkward to pronounce, or which may be difficult on your vocal cords.

 
      /* [Begin Comment]
      () [Empty Function]
      != [Is Not Equal to]
      (  [Function of]
      && [Logical and]

Count syllables, not characters (and don't be too stingy with syllables either). We have all learned to program from people trying to save keystrokes. Now we have to un-learn this habit.

Choose names which are easy to recognize:

Avoid single syllables and awkward abbreviations.

 
      char*   [Pointer to Character]
      if (    [If the Expression]
      log(    [Natural Logarithm of]
      argv    [Argument Values]

Avoid similar sounding words.

Feel free to extra words.

 
      NULL       [Null Value]
      tan(       [Tangent of]
      while (    [While It's True That]

Program in English:

Describe what you're doing, not what symbols you would type.

 
      [X. to the Power Y.]
        pow( 
      [Print Formatted]
	printf( 
      [Copy String]
	strcpy( 
      [Copy Partial String] 
	strncpy( 

Don't be tied to the language.

 
      [If the Expression]
	if (
      [Then Do the Following]
	) {{}{enter}

If the same symbol has different meanings (or different spacing), then use different macros.

 
    [        [Indexed by]
    &        [Address of]
    *        [Target of]
    !        [False That]
    ;{enter} [End Command]

At this point, an example is probably in order. If I say,

 
  [While It's True That]
    [Target of] next 
    [Is Not Equal to] [Null Value]
  [Then Do the Following]
    [Increment] count [End Command]
    current [equals] next [End Command]
    next [equals] current 
    [Right Arrow] [End Command]
  [End Block]

DragonDictate will type

 
  while (*next != NULL ) {
    ++count;
    current = next;
    next = current->next;
  }

Return to the outline/title page

Return to At A Word home page

This document last modified on 1/10/2002

Questions? contact web@ataword.com