this post was submitted on 12 Apr 2024

801 points (98.8% liked)

Programmer Humor

19544 readers

518 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

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

founded 1 year ago

MODERATORS

Feyter@programming.dev

anzo@programming.dev

BurningTurtle@programming.dev

pylapp@programming.dev

801

We'll refactor this next year anyways (programming.dev)

submitted 7 months ago by popcar2@programming.dev to c/programmer_humor@programming.dev

50 comments fedilink hide all child comments

you are viewing a single comment's thread
view the rest of the comments

[–] JayDee@lemmy.ml 11 points 7 months ago* (last edited 7 months ago)

The 'document' part also seems to be insanely hit-or-miss from my amateur experience. Self-documenting design/code is... well, not. Auto-generated documentation is also usually just as bad IMO. Producing good documentation really is a skill in and of itself.

Also small personal opinion: If your abstraction layers or algorithms are based off a technical concept, you should probably attribute that concept and provide links to further research, to eliminate future ambiguity or in case your reader lacks that background. Future you will probably thank you and anyone like me who immediately gets lost in jargon soup will also be thankful.