CodingStandards

From Audacity Wiki
Revision as of 03:50, 19 January 2006 by 63.238.214.63 (talk) (Revert spam vandalism)
Jump to: navigation, search

While we're not particularly anal about coding standards, there are a few things that we try to do consistently. This is best summarized with an email that Josh sent to the list on the subject:


The main things are:

  • spaces, no tabs
  • 3 spaces per indent

As far as naming:

  • classes and methods are CamelCase
  • local variables are firstLoweredCamelCase
  • member variables are mVar.
  • globals are usually gVar.

The rest varies a lot, and isn't too important.

Josh ---

We're also slowly moving towards more DoxyGen friendly code, so comments at the start of functions with the DoxyGen /// marker are encouraged.

James