Re:Super Tiny Compiler
by eveningcoffee on Tuesday April 12, 2016 @08:31PM
(#11484775)
Please DO NOT. You are right in your other comment that it helps with the flow and for example in the case of
// We're going to create a `value` string that we are going to push
// characters to.
var value = '';
your comment declares you intention in advance, even if it might be trivial to deduce.some people get really weird about comments.
in a case like this, i actually like the dialogue/conversation nature of the comments. i think the opinion of "not needing them" seems miss what they're accomplishing.
Comments about intention are good.
Yes, an experienced dev can infer intent from context (name, project, 'culture'), and even a smart beginner can read ahead to infer intent. But the comment resolves ambiguity in the advanced dev's mind, and saves the beginner's mind from the difficulty of read-ahead inferences (of which he may have several going at once).
I say, keep it.
I ripped these code comments from my presenter notes where I was explaining everything in case people couldn't read it.
I'll have to go back in and clean it up