Defined a rule for variable and constant numeric types
[pingcheck] / Readme
1
2 Code Conventions
3 =======================================
4 This section describes the code conventions that must be followed when maintain
5 this code.
6
7
8 Data Types
9 ---------------------------------------
10
11 Use std::string to represent array of characters.
12
13 Use int32_t, int16_t and int8_t (and their unsigned couter parts) instead of
14 int, short and char, respectively, when the variable or constant MUST have a
15 specific size (e.g. like in the protocol headers). This documents that the
16 variable have the given number of bits.
17
18 Use std::size_t for regular integer numbers that do not require any specific
19 size. Thus leaving the size difinition to the platform.