wdb:developers:coding_style_guide

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
wdb:developers:coding_style_guide [2008-01-24 10:15:59]
michaeloa
wdb:developers:coding_style_guide [2022-05-31 09:29:32] (current)
Line 17: Line 17:
  
 The style guide applies to C++ code. The style guide applies to C++ code.
 +
 +
  
  
Line 26: Line 28:
 A name is the result of a long deep thought process about context of the entity. Only a programmer who understands the system as a whole can create a name that "fits" with the system. If the name is appropriate everything fits together naturally, relationships are clear, meaning is derivable, and reasoning from common human expectations works as expected. A name is the result of a long deep thought process about context of the entity. Only a programmer who understands the system as a whole can create a name that "fits" with the system. If the name is appropriate everything fits together naturally, relationships are clear, meaning is derivable, and reasoning from common human expectations works as expected.
 If you find all your names could be Thing and DoIt then you should probably revisit your design. If you find all your names could be Thing and DoIt then you should probably revisit your design.
 +
 +Philosophy aside, there is a very simple reason to have naming conventions. Having naming conventions saves time; it means that you don't constantly have to look up the source to verify whether MyClass or MyFile are spelled with a large or small 'M'.
  
 ==== Class Names ==== ==== Class Names ====
  • wdb/developers/coding_style_guide.1201169759.txt.gz
  • Last modified: 2022-05-31 09:23:29
  • (external edit)