Please add comments to the code

[scotthibbs]

Send us feedback

NamasenITN wrote me on youtube, "I would love to join forces! Do you have or will have or could have a code-base walk-through?" I could not figure out the math for the frequency-domain emulation of atmospheric noise and honestly got lost in the original code base that had not a single comment."

As you move through the code of this program, take a second to comment what each section does.

[w7sst]

I have been adding comments to the code as I learn/understand the existing code base and when writing new code. I have always believed that comments in the code serve a good purpose and should explain the big picture of what it is doing and why. The original MR code was lacking comments, so adding them will only help future developers/coders to understand this code base. I will continue to add comments over time.

I have also added some UML (Unified Modeling Language) diagrams showing the overall design. This work can be extended further as time allows.

I will continue to add comments as I go along. In fact, it may be a good idea just to make a pass through the code and document the main control flow and perhaps the audio path (describe how the audio is generated once the simulation has started). I think both of these would be beneficial.

Other ideas:

• Others should also be encouraged to add comments as they go.
• We should reach out to Alex, the original author, to see if he has any old design documents or notes that he might be able to share with us.