C programming/House of Technology C coding policy

This article is under development....

Naming

Variable names

• All variable names should be in lower case.
• All variable names should describe purpose and content.
• Use _ (underscore) as space.
  • Use int timer0_instance_counter instead of int timer0InstanceCounter
    • If you abbreviate and use tim0_inst_cnt remember to list the abbreviations in the Abbreviation Table.

Function names

• All function names should be in lower case.
• All function names should describe purpose and function.
• Use _ (underscore) as space.
• Use galaxy_soarsystem_planet approach instead of planet_solarsystem_galaxy

best approach	dont use
timer0_start()	start_timer0()
timer0_stop()	stop_timer0()
timer0_init()	init_timer0()
timer1_start()	start_timer1()
timer1_stop()	stop_timer1()
timer1_init()	init_timer1()

Abbreviations

If abbreviations are used - use logical abbreviations and make a abbreviation table

/*Abbreviation Table
disp       == display
dsp        == digital signal processor
tim        == timer
inst       == instance
cnt        == counter

...
*/

Programming style

Indents

Use K&R or Allman indents. But do it consistently.

K&R example

if (x == y) {
    x++;
    foo();
} else {
    x--;
    bar();
}

Allman

if (x == y) 
{
    x++;
    foo();
} 
else 
{
    x--;
    bar();
}

Documenting

Module headers

.c files

Der anvendes ikke versionsnummer i moduler. Der anføres dato/forfatter og beskrivelse af ændring i modification log.

/**************************************************************************
  #     #
  ##   ##  ######  #####    ####     ##    #    #   #####  ######   ####
  # # # #  #       #    #  #    #   #  #   ##   #     #    #       #    #
  #  #  #  #####   #    #  #       #    #  # #  #     #    #####   #
  #     #  #       #####   #       ######  #  # #     #    #       #
  #     #  #       #   #   #    #  #    #  #   ##     #    #       #    #
  #     #  ######  #    #   ####   #    #  #    #     #    ######   ####
 
***************************************************************************
Author..: name <mail@address>
Company.: House of Technology at Mercantec ( http://www.mercantec.dk )
date....: 2012 Nov. 13
***************************************************************************
Abstract: Brief description (two to ten lines)
Purpose.: The purpose of the module. (one or two lines)
***************************************************************************
Cavets..: Description of problems and future extensions
***************************************************************************
Modification log: 
***************************************************************************
License:  Free open software but WITHOUT ANY WARRANTY.
Terms..:  see http://www.gnu.org/licenses
***************************************************************************/