Skip to content

Code rules

Mikulas Florek edited this page Mar 21, 2016 · 10 revisions
  • The first rule of Code Rules is: You do not talk about Code Rules.
  • Quality is the most important feature.
  • Write for readers - code is read and debugged many more times than it is edited.
  • Consistency - look at the way things are already done - formatting, filenames, structure, ...
  • Keep it simple, stupid.
  • Templates, C++11, ... use whatever you think is reasonable if it works on all supported platforms (At least Win, Mac, Linux, even though Mac and Linux have not been implemented yet, they will be).
  • Asserts should not be triggered by data and invalid data can not cause crashes.
  • Using clang-format is preferred, there is a config for it
Clone this wiki locally