Guidelines » History » Revision 13
Revision 12 (Greg Burri, 07/20/2009 01:23 PM) → Revision 13/24 (Greg Burri, 08/01/2009 07:45 PM)
h1. Guidelines
h2. Documentation
* Use of ' when referencing a name like 'myVar'
* Use of " when referencing a value like "my string"
h2. Coding
See the prototypes for code reference : source:/prototypes.
h3. Some random rules
* Try to minimize the use of dynamic allocation. Use constructor initializer to set non-pointer members.
* Use parameter references variable passing instead of pointers.
* Always have the design pattern "RAII":http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization in mind.
h2. Version number
A version number has three numbers plus a tag :
_<a>.<b>.<c> <tag>_
_<a>_ : Major version
_<b>_ : Evolution
_<c>_ : Revision (bugfixes)
_<tag>_ : alpha | beta | <nothing>
For example :
* _1.0 alpha_ (first version)
* _1.0 beta_
* *_1.0_* (stable version)
* _1.0.1_ (first revision)
* _1.0.2_ (second revision)
* _1.1 alpha_ (first evolution)
* _1.1 beta_
* *_1.1_*
* _1.1.1_
* etc..
h3. Beta and alpha versions
The alpha is a development version not yet finished only for developers.
The beta is an almost released version that can be public.