• 0 Posts
  • 17 Comments
Joined 2 years ago
cake
Cake day: June 24th, 2023

help-circle






  • Comment should describe “why?”, not “how?”, or “what?”, and only when the “why?” is not intuitive.

    The problem with comments arise when you update the code but not the comments. This leads to incorrect comments, which might do more harm than no comments at all.

    E.g. Good comment: “This workaround is due to a bug in xyz”

    Bad comment: “Set variable x to value y”

    Note: this only concerns code comments, docstrings are still a good idea, as long as they are maintained




  • Not the Doppler effect, as that only applies to moving objects, but instead the inverse square law, where the energy of the sound wave decreases by the square of the distance from the origin, since it spreads in a sphere with the energy being spread across the surface of the sphere, resulting in a very quick dropoff in the loudness.