heikomat

@heikomat@lemmy.world

• ⁨Comment⁩ on ⁨Bill is a pro grammer⁩ ⁨⁨11⁩ ⁨months⁩ ago⁩:

  If the comments tell you “what” happens, then yes, they can geht outdated fast. The details of how something works can change quickly.

  But comments documenting “why” something is done (a certain way) - explaining the intent - are probably valid for mich longer.

  In the best case comments aren’t viewed as something that is seperate from the code, but part of it. So that if someone changes the code, the comments has to be checked aswell (if the explanation of “why” something is done actually changed).

• ⁨Comment⁩ on ⁨Bill is a pro grammer⁩ ⁨⁨11⁩ ⁨months⁩ ago⁩:

  Exactly that! Everyone can See “what” is happening, thr code is right there. But the code usually doesn’t tell you “why” that is happening - good comments help understand the authors intent and give context, so you don’t have to guess.

  Good comments should explain the things that are not obvious.

  Good comments more than once prevented me from accidentially undoing a fix.