707
Bill is a pro grammer (sh.itjust.works)
you are viewing a single comment's thread
view the rest of the comments
[-] heikomat@lemmy.world 5 points 1 year 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).

this post was submitted on 26 Nov 2023
707 points (89.3% liked)

Programmer Humor

19623 readers
1 users here now

Welcome to Programmer Humor!

This is a place where you can post jokes, memes, humor, etc. related to programming!

For sharing awful code theres also Programming Horror.

Rules

founded 1 year ago
MODERATORS