Home

Welcome to the place that describes our coding standard in detail, with the intent of highlighting all macroscopic and microscopic components to arrangement and placement of code and text.

The coding standard is C/C++ biased, but is written in the hopes being generalised enough to apply to any C-influenced language (e.g.: Java, Objective-C).

Because of the time wasted following (and being confused by and/or clashing between) multiple standards, this coding standard is made to apply as consistently as possible to a variety of languages. The idea is that following similarities takes much less thought, enabling you to produce code with fewer distractions.

Tip: Getting Started

On your first read of the coding standards, it is suggested to get the overall feel of the style by going through the following sections firstly, in the order listed.

• General Whitespace
• Language
• Documentation

What Does This Not Do?

We maintain the philosophy that a coding standard strictly applies to layout and formatting, not covering code design.

For code design, you should read up on best practices, and generally follow the project's conventions.

That being said, your code should prioritise the following:

• Simplicity
• Usability
• Maintainability
• Dependability
• Cross-platform compatibility

Note that efficiency is explicitly not part of the list. Only make changes for efficiency after measuring the performance with A/B Testing (prove it!), and be sure the changes do not sacrifice anything from the list above.

Some Best Practices

Outside of the scope of this coding standard are some concepts better described by external sources.

• Dogfooding
• KISS
• Proudly Found Elsewhere
  • Opposite of Not Invented Here

Influences

• JUCE Coding Standards
• ISO CPP Core Guidelines
• Google C++ Style Guide