You are viewing a single thread.
View all comments View context
63 points
*

The allowable exception is when the what is a what the fuck, as in you had to use a hack so horrible that it requires an apology comment

permalink
report
parent
reply
15 points

Absolutely, although I see that as part of why

Why is there a horrible hack here? Because stupid reason…

permalink
report
parent
reply
5 points

Or if the what is so cryptic and esoteric that it would require the reader a couple hours of research to understand it.

Also, I find it useful to summarise the what before code blocks if that can’t be summarised in a function name

permalink
report
parent
reply
4 points

Describing the what also helps when you dabble in a new technology or little-used technology. It helps to explain to yourself what you’re doing and it helps in onboarding. “Hey, newbie, there’s a function in XYZ module that’s extensively documented. Look there for guidance.”

permalink
report
parent
reply

Programmer Humor

!programmer_humor@programming.dev

Create post

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

  • Keep content in english
  • No advertisements
  • Posts must be related to programming or programmer topics

Community stats

  • 2.5K

    Monthly active users

  • 866

    Posts

  • 14K

    Comments