338
you are viewing a single comment's thread
view the rest of the comments
[-] iegod@lemm.ee 23 points 1 year ago* (last edited 1 year ago)

Oh fuck I hate encountering this level of commenting. If it's complicated, you should have a design doc. Source code is not where you write your dissertation. Simple explanations are good, especially since the code could be updated while the comment is likely to remain unchanged. Long expositions are usually the result of bad coding or improperly allocated design.

[-] MrTallyman@programming.dev 11 points 1 year ago

Absolutely agreed. If your code line by line isn't clear, then the code is the problem.

Commenting before a block of code (a function / algorithm or whatever) explaining what it is meant to do, absolutely that's great though, saves time when revisiting.

[-] hstde@feddit.de 2 points 1 year ago

As long as it's updated when the code changes

[-] r1veRRR@feddit.de 1 points 1 year ago

And that one single line that makes zero FUCKING SENSE AND YOU SPENT 5 DAYS TRYING TO FIX IT!!! That definitely needs a comment so the next idiot (aka you in 6 months) doesn't think "what useless shit is this? Let's delete this!".

this post was submitted on 01 Sep 2023
338 points (96.2% liked)

Programming

17119 readers
136 users here now

Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!

Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.

Hope you enjoy the instance!

Rules

Rules

  • Follow the programming.dev instance rules
  • Keep content related to programming in some way
  • If you're posting long videos try to add in some form of tldr for those who don't want to watch videos

Wormhole

Follow the wormhole through a path of communities !webdev@programming.dev



founded 1 year ago
MODERATORS