Code style wishlist

[jpcima]

A few ideas, all open to discussion

• [ ] in *.cpp files, everything inside sfz namespace, instead of repeating sfz:: everywhere ie. namespace sfz { [...] } // namespace sfz
• [ ] instance variables with _ suffix, to make it evident when we're deferencing this
• [ ] fix the space/tab mix in Defaults.h
• [ ] rewrite all doc comments in a consistent way

  /**
  * @brief A good doc comment
  */
  /**
  @brief A bad doc comment
  */

• [ ] cpp files should preferably not include other cpp files (with possible exception of faust-generated ones) eg. #include "ADSREnvelope.cpp" in FloatEnvelopes.cpp

Edit:

• [ ] consistent includes order and style. a suggestion:
  • the header which pairs with the source file, in "" style
  • sfizz other headers in "" style
  • thirdparty and external library headers in <> style
  • non-language-standard system libraries in <> style (eg. part of POSIX/Win32, not C standard, such as unistd.h)
  • pseudo-standard libraries in <> style (ghc, absl)
  • standard libraries in <> style (C++ first, then C)

[redtide]

Sorry, I "edited" it by mistake but not changed anything, like a "I'm a simple man, I see a checkbox and I select it." :-P If I can put my cent on it that sounds like the way I use to code except:

1. the _ suffix, which I agree but still about personal taste (e.g. also as prefix or m_ prefixed
2. I like the bad doc comment and I never understand why automatic Doxygen editors puts all those unneeded asterisks where starting with an indentation looks more clean and readable to me, but this is also (my) personal taste

Despite the 2 personal points above all of that makes sense to me.

[paulfd]

I'm okay with all this, I have no strong opinions. I tend to prefix with _ in python but I'm flexible :)

I also think we could pimpl everything if you wish. One thing that we may discuss is the Impl& impl = *impl_; that you put in the parent calls: what's the reason?

[jpcima]

I tend to prefix with _

The prefix _ is reserved for compilers.

what's the reason?

It's for no other reason than to help the compiler, writing such a this as impl_->x dereferences twice.

[jpcima]

Added an item regarding the include file order, see the top comment