6 ms·
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 jus
by bonoetmalo 9y ago
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"
- throwawayfinal 9y agoMore than once, cutesy comments of frustration have led me to inspect something for side effects and avoid them.
- kakwa_ 9y agoCould it not be done through conventional ways like TODO or FIXME?
- throwawayfinal 9y agoSometimes 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."
- jowiar 9y agoI'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.
- kakwa_ 9y ago"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