Difference between revisions of "C programming/House of Technology C coding policy"
From Teknologisk videncenter
m (→Variable names) |
m (→Abbreviations) |
||
Line 36: | Line 36: | ||
disp == display | disp == display | ||
dsp == digital signal processor | dsp == digital signal processor | ||
+ | tim == timer | ||
+ | inst == instance | ||
cnt == counter | cnt == counter | ||
+ | |||
... | ... | ||
*/ | */ | ||
</source> | </source> | ||
[[Category:C]] | [[Category:C]] |
Revision as of 06:40, 7 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
- If you abbreviate and use tim0_inst_cnt remember to list the abbreviations in the Abbreviation Table.
- 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
tim == timer
inst == instance
cnt == counter
...
*/