Code formatting conventions

Wiki

To insert code, use the <code cpp> tag.

Thou shalt in all your code use the Allman's style brace indentation.

struct MyStruct
{
    int32_t uselessField;
    uint16_t anotherUselessField;
}

When defining fields of number type, you must use the types defined in stdint.h :

Specifier	Signing	Bits	Bytes	Minimum Value	Maximum Value
`int8_t`	Signed	8	1	−2⁷ which equals −128	2⁷ − 1 which is equal to 127
`uint8_t`	Unsigned	8	1	0	2⁸ − 1 which equals 255
`int16_t`	Signed	16	2	−2¹⁵ which equals −32,768	2¹⁵ − 1 which equals 32,767
`uint16_t`	Unsigned	16	2	0	2¹⁶ − 1 which equals 65,535
`int32_t`	Signed	32	4	−2³¹ which equals −2,147,483,648	2³¹ − 1 which equals 2,147,483,647
`uint32_t`	Unsigned	32	4	0	2³² − 1 which equals 4,294,967,295
`int64_t`	Signed	64	8	−2⁶³ which equals −9,223,372,036,854,775,808	2⁶³ − 1 which equals 9,223,372,036,854,775,807
`uint64_t`	Unsigned	64	8	0	2⁶⁴ − 1 which equals 18,446,744,073,709,551,615

Also, when defining pointer fields, the * must be on the right-side:

uint32_t *fieldName;

instead of

uint32_t* fieldName;

wiki/conventions.1490457210.txt.gz · Last modified: 2017/03/25 15:53 (external edit)

Back to top