Guidelines » History » Version 13
Greg Burri, 08/01/2009 07:45 PM
| 1 | 1 | Greg Burri | h1. Guidelines |
|---|---|---|---|
| 2 | |||
| 3 | h2. Documentation |
||
| 4 | |||
| 5 | * Use of ' when referencing a name like 'myVar' |
||
| 6 | * Use of " when referencing a value like "my string" |
||
| 7 | |||
| 8 | 2 | Greg Burri | h2. Coding |
| 9 | 1 | Greg Burri | |
| 10 | 12 | Greg Burri | See the prototypes for code reference : source:/prototypes. |
| 11 | 5 | Greg Burri | |
| 12 | 13 | Greg Burri | h3. Some random rules |
| 13 | |||
| 14 | * Try to minimize the use of dynamic allocation. Use constructor initializer to set non-pointer members. |
||
| 15 | * Use parameter references variable passing instead of pointers. |
||
| 16 | * Always have the design pattern "RAII":http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization in mind. |
||
| 17 | |||
| 18 | |||
| 19 | 5 | Greg Burri | h2. Version number |
| 20 | |||
| 21 | A version number has three numbers plus a tag : |
||
| 22 | _<a>.<b>.<c> <tag>_ |
||
| 23 | |||
| 24 | _<a>_ : Major version |
||
| 25 | _<b>_ : Evolution |
||
| 26 | 11 | Greg Burri | _<c>_ : Revision (bugfixes) |
| 27 | 5 | Greg Burri | _<tag>_ : alpha | beta | <nothing> |
| 28 | |||
| 29 | For example : |
||
| 30 | 7 | Greg Burri | * _1.0 alpha_ (first version) |
| 31 | 5 | Greg Burri | * _1.0 beta_ |
| 32 | 7 | Greg Burri | * *_1.0_* (stable version) |
| 33 | 11 | Greg Burri | * _1.0.1_ (first revision) |
| 34 | 7 | Greg Burri | * _1.0.2_ (second revision) |
| 35 | * _1.1 alpha_ (first evolution) |
||
| 36 | 5 | Greg Burri | * _1.1 beta_ |
| 37 | 6 | Greg Burri | * *_1.1_* |
| 38 | 5 | Greg Burri | * _1.1.1_ |
| 39 | * etc.. |
||
| 40 | 8 | Greg Burri | |
| 41 | h3. Beta and alpha versions |
||
| 42 | |||
| 43 | The alpha is a development version not yet finished only for developers. |
||
| 44 | 9 | Greg Burri | The beta is an almost released version that can be public. |