AntonioND
commented
1 week ago I've spent a few hours with clang-format and "Artistic Style" https://astyle.sourceforge.net/ and I'm pretty disappointed with the results of the tools in general.
clang-format:
- Pro: It can fix the format of all the elements in the code, it can even tell apart
*of a multiplication from*used to declare a pointer. - Con: However, things like a
*multiplication inside a macro will be treated sometimes like a pointer. There are some issues like this with&as well. - Con: It is very strict with line length, to the point of breaking many lines in awkward ways, and many comments, even if they overflow by one or two characters (which would normally be okay).
- Con: Different versions of the tool produce different results.
- Con: Coming up with a good configuration is way too hard. For example, with Allman braces style the
extern "C"statements in all headers will cause all the other elements inside theextern "C"to be indented, and this can't be disabled manually: https://stackoverflow.com/questions/65866419/unable-to-disable-extern-indentation-with-clang-format
Artistic Style:
- Pro: It's fairly easy to configure and it's easy to relax rules so that a human can format code so that it looks nice.
- Pro: It's easy to stick to one version of the tool and have consistent results.
- Con: It doesn't understand the context of each token, so things like
*and&are pretty broken.
In short... for now, let's not do this. I may spend a bit of time writing a document with some broad code style rules, and leave the rest to the discretion of the developer.
profi200
clang-formatexists, let's make use of it.I have no strong opinions here, other than that:
clang-formatprovides LLVM, Google, Chromium, Mozilla, WebKit, Microsoft), with some changes of our own,// clang-format offmay need to be used judiciously in areas which define registers and other such constants, as we may end up relying on unique formatting there to make it more readable for a human.