// If this happens, I am going to quit and become a barista

Re:// If this happens, I am going to quit and become a barista by bonoetmalo on Monday February 05, 2018 @01:45PM (#16310922)

I gotta admit, I cringe a little when I see cutesy comments like this in professional code. I see it occasionally in our codebase, through stylecop override justifications "OMG this is the right way" or "// i hate this but whatever"

[ Parent | on HN ]

Re:// If this happens, I am going to quit and become a barista by jowiar on Monday February 05, 2018 @04:29PM (#16312363)

I'll take it over nothing, though.

I'm generally a fan of documenting when you do something and don't like it, though it's generally useful to use something a hair more constructive. At the very least, though, leaving a signifier to future-self or future-non-self that the decision was made as a "least worst option" or a "doesn't matter now, may matter in the future" or otherwise "I don't like this, but doing better is not my immediate problem".

Basically, having any context into why a decision was made is an extremely useful artifact.

[ Parent | on HN ]

Re:// If this happens, I am going to quit and become a barista by throwawayfinal on Monday February 05, 2018 @01:55PM (#16311012)

More than once, cutesy comments of frustration have led me to inspect something for side effects and avoid them.

[ Parent | on HN ]

Re:// If this happens, I am going to quit and become a barista by kakwa_ on Tuesday February 06, 2018 @03:04AM (#16314993)

Could it not be done through conventional ways like TODO or FIXME?

[ Parent | on HN ]

Re:// If this happens, I am going to quit and become a barista by throwawayfinal on Tuesday February 06, 2018 @03:48PM (#16319433)

Sometimes there's not something to fix or do, for example, in pthread-using code. "Just be really fucking careful or we'll all cry a lot."

[ Parent | on HN ]

Re:// If this happens, I am going to quit and become a barista by kakwa_ on Tuesday February 06, 2018 @03:02AM (#16314989)

"And then you can took a look at the commit messages and you cringed more than a little".

Commit history in cowboy projects tends to be really bad.

I've seen a lot of "not so professional" comments in them like:

* empty message

* single word message like "update" or "hack"

* onomatopoeia (arghhh!!!!, yargla!!!!)

* all upper case commit message raging against the company and its lack of recognition

[ Parent | on HN ]