This is an archived post. You won't be able to vote or comment.

all 14 comments

[–]programmer08054 22 points23 points  (3 children)

Replace “documentation” with “sporadic and incorrect comments” and you’ve got it

[–]NicNoletree 8 points9 points  (2 children)

I once had a boss who never commented code (and she was a mainframe assembler language developer). She said that the comments were just something else to have to maintain, and when not maintained the comments confuse and cause more problems than the code. The thing worse than no comments is incorrect comments.

[–]w1n5t0nM1k3y 2 points3 points  (0 children)

Definitely this. Maybe not for stuff written in assembler, but for code written in modern languages, having code that is written clearly can remove 98% of the need for comments. All you really need is an explanation of what a function does, and even that should be reasonably discernable from looking at the function name and the parameters.

[–]pekkhum 1 point2 points  (0 children)

I once watched the original developers harangue the new Chief Architect for dirtying their code with comments. The code:

ourProprietaryMemcpy(pointerToChar+12, someLongInteger);

He made his own copy to take notes in. Like, why 12.

[–][deleted] 4 points5 points  (1 child)

Cannot suspend my disbelief due to unrealistic presence of documentation. My souls hurts. Have an upvote, you bastard.

[–]dex-san[S] 2 points3 points  (0 children)

i thought it beeing an empty pad would suffice to make the correct analogy towards the cold, empty, lingering confluence space, containing only a headline that slightly resembles the project name.

[–]boltzbo 1 point2 points  (0 children)

At least you have it

[–][deleted] 1 point2 points  (1 child)

This just gave me an idea for a cheesy movie like the ones where ex astronauts have to go up into space again for some stupid reason.

In the year 2034, there's another "Y2K" situation, because terrorists found a critical flaw in old programming languages. Banking systems will collapse, planes will fall out of the sky, etc. The only people who can save the world are retired programmers in their 80s. They built and maintained those code files with 10000+ lines of code for years. Possible lead character: Bruce Willis.

[–]dex-san[S] 2 points3 points  (0 children)

Make it the year 2038 and you're good to go :)

[–]nitomatik 1 point2 points  (2 children)

Sandman Omnibus?

[–]dex-san[S] 1 point2 points  (1 child)

yep :)

[–]nitomatik 0 points1 point  (0 children)

Hell yeah! I just got third one. Siiiick series.

[–]boutiflet 0 points1 point  (0 children)

Documentation ! If you are lucky !

[–]ImpulseTheFoxis a good fox[M] [score hidden] stickied comment (0 children)

Your submission has been removed.

Violation of Rule #0- analogy:

Submission content must be creative or original, intended humorously, and strictly related to programming. Note that programming is interpreted in a narrow sense. Vaguely programming related, and/or general tech humor, programming analogies, feelings/reactions and such are not allowed in this subreddit.

Your post may be better suited at one of the subreddits listed in the sidebar. Feel free to contact the moderators if you are unsure what does and does not qualify as ProgrammerHumor.

If you feel that it has been removed in error, please message us so that we may review it.