Difference between revisions of "Cpp Coding Standards/FIMPL"

From Apache OpenOffice Wiki
Jump to: navigation, search
(formatting, fix links)
m (No Magic Numbers <span id="MagNum">(MagNum)</span>)
 
Line 8: Line 8:
  
 
===== No Magic Numbers <span id="MagNum">(MagNum)</span> =====
 
===== No Magic Numbers <span id="MagNum">(MagNum)</span> =====
Don't use unnamed constants in your code. Give them a descriptive name. [[/MagNum|-> Details]]
+
Don't use unnamed constants in your code. Give them a descriptive name. The definition is prefered in the headers [[/MagNum|-> Details]]
  
 
===== Default in switch Statements <span id="DefSwitch">(DefSwitch)</span> =====
 
===== Default in switch Statements <span id="DefSwitch">(DefSwitch)</span> =====

Latest revision as of 21:33, 30 July 2008

Function Implementation (FIMPL) - Summary

Issues when implementing function bodies.

Short Functions (Short)

Make functions short.

Consider replacing comments by function calls. Consider to flatten deep nested control structures by moving parts of them in extra functions. Consider moving complicated loop bodies into extra functions. Put repeated code snippets in an extra function. -> Details

No Magic Numbers (MagNum)

Don't use unnamed constants in your code. Give them a descriptive name. The definition is prefered in the headers -> Details

Default in switch Statements (DefSwitch)

Don't just drop out of a switch statement, always provide a default case or a comment, why it is not needed.
Comment missing breaks.
-> Details

No Catch All (Catch)

Avoid catch(...). -> Details


Related Rules


Personal tools