CPMDude89 / procedural_drone

0 stars 0 forks source link

Naming Conventions #6

Open mhamilt opened 3 years ago

mhamilt commented 3 years ago

Until you have strong opinions, try and stick with a consistent naming convention.

Instead of

https://github.com/CPMDude89/procedural_drone/blob/e6f4634888499445e15077cac1fcaef9c6359d12/Source/PluginProcessor.h#L63-L64

try

ThickSynth thickSynth; 
ChasingSynth chasingSynth; 

and instead of:

https://github.com/CPMDude89/procedural_drone/blob/e6f4634888499445e15077cac1fcaef9c6359d12/Source/PluginProcessor.h#L67-L72

Try

    float sampleRate; // sample rate
    float thickSynthRawSample; // thick synth pre-filter sample
    float thickSynthSample; // thick synth post-filter sample
    float chasingSynthSample; // chase synth sample
    float thickSynthGain = 0.6; // thick synth gain
    float chasingSynthGain = 0.09; // chase synth gain

Comments here are also a little tautological, so you may want to explain purpose rather than describe what the variable represents.

These kinds of variables would also suggest we have some organisational problems a little further done the line.

CPMDude89 commented 3 years ago

I see you are trying to get me out of a bad habit of making very short variable names. Thank you, I see why that is a clearer way to code