this post was submitted on 21 Oct 2024
86 points (86.4% liked)

Programming

17667 readers
275 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 [email protected]



founded 2 years ago
MODERATORS
86
Self-documenting Code (lackofimagination.org)
submitted 2 months ago by Aijan to c/programming
you are viewing a single comment's thread
view the rest of the comments
[โ€“] hex 1 points 2 months ago (1 children)

You make some great points. Using smaller functions and breaking up your code in readable bits makes a huge difference and you will likely never need comments if you do it right ๐Ÿ‘๐Ÿป

[โ€“] nous 4 points 2 months ago (1 children)

Creating functions is IMO not the first thing you should do. Giving variables better names or naming temporaries/intermediate steps is often all you really need to do to make things clearer. Creating smaller functions tends to be my last resort and I would avoid it when I can as splitting the code up can make things harder to understand as you have to jump around more often.

[โ€“] hex 1 points 2 months ago

I hear ya. As always, it's a balance between having functions that are too long, and many too small functions. Matter of team preferences too.