Skip to content

dev.CodingConventions

Thomas Mann edited this page Feb 26, 2024 · 2 revisions

Coding Conventions

Return statements should be in a separate line

if (_midiEventCollection == null) return; //❌
if (_midiEventCollection == null)  //✔
     return;

Comments should start with an uppercase character

// looks like code
// Better 

No commented code without introducing comment

We're using git for version control and to keep backups of no longer needed variations and experiments. If you comment out a line of code, please remove it before committing. This is valid for c# and hlsl code alike.

If commented out code is useful for understanding existing code, please add a comment explaining why the code is commented out.

Clone this wiki locally