Difference between revisions of "C programming/House of Technology C coding policy"

From Teknologisk videncenter
Jump to: navigation, search
m
m (Function names)
Line 8: Line 8:
 
*All function names should be in lower case.
 
*All function names should be in lower case.
 
*All function names should describe purpose and function.
 
*All function names should describe purpose and function.
 +
*Use _ (underscore) as space.
 
*Use '''galaxy_soarsystem_planet''' approach instead of '''planet_solarsystem_galaxy'''
 
*Use '''galaxy_soarsystem_planet''' approach instead of '''planet_solarsystem_galaxy'''
 
{|
 
{|
Line 26: Line 27:
 
|-
 
|-
 
|}
 
|}
 +
 
=Abbreviations=
 
=Abbreviations=
 
If abbreviations are used - use logical abbreviations and make a abbreviation table
 
If abbreviations are used - use logical abbreviations and make a abbreviation table

Revision as of 13:16, 6 June 2012

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

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
cnt        == counter
...
*/