Improve style guide data type documentation - Githubissues

wpilibsuite / allwpilib

Official Repository of WPILibJ and WPILibC

https://wpilib.org/

Other

1.06k stars 614 forks source link

Improve style guide data type documentation #159

Closed calcmogul closed 8 years ago

calcmogul commented 8 years ago

These should be integrated into the style guide eventually.

General

C++ is intended to be fast, so implementation tradeoffs should be biased toward that

Type Names

HAL should use stdint.h typedefs
wpilibc
- use int in user-facing interfaces instead of int32_t or uint32_t
- all integer types shall be signed in external interfaces
- only use unsigned types for internal bitwise arithmetic
wpilibj
- use int in user-facing interfaces instead of byte

Floating Point

doubles should be used everywhere instead of floats
- compiling with optimization turned on shows negligible performance impact compared to floats

Generated Files

Since changes would be overwritten upon regeneration, generated files should not be modified under any circumstances, including for formatting changes. The generator for those files should be modified instead.
The current list of generated files is represented by regular expressions in styleguide/task.py.

calcmogul commented 8 years ago

This information has been added to the style guide.