Style guide » History » Version 3
Giulio Moro, 2015-09-14 04:23 PM
| 1 | 1 | Giulio Moro | h1. Style guide |
|---|---|---|---|
| 2 | 1 | Giulio Moro | |
| 3 | 2 | Giulio Moro | You are welcome to contribute to this repository. If you decide to, please follow our style guide (which we have not followed thoroughly ourselves so far, but we are trying to improve). |
| 4 | 1 | Giulio Moro | |
| 5 | 1 | Giulio Moro | * use tabs for indentation |
| 6 | 1 | Giulio Moro | * space around every mathematical/binary operator (=, *, +, <<, etc.) |
| 7 | 3 | Giulio Moro | * but no space inside parens ---> |
| 8 | 3 | Giulio Moro | <pre> |
| 9 | 3 | Giulio Moro | if(a == 2) not if( a == 2 ) nor if(a==2) |
| 10 | 3 | Giulio Moro | </pre> |
| 11 | 1 | Giulio Moro | * space between comment symbol and beginning of text: // Like this |
| 12 | 1 | Giulio Moro | * comments aligned to same indentation as the code |
| 13 | 2 | Giulio Moro | * documentation in the .h files using Doxygen syntax |