5 ms·
While I agree with the general sentiment, the first example in the article IMO demonstrates how "what" comments make understanding code easier. When I first rea
by ainzzorl 5y ago
While I agree with the general sentiment, the first example in the article IMO demonstrates how "what" comments make understanding code easier. When I first read that code, I was pleasantly surprised how easy it was to understand everything going on there, even though I had no familiarity with the code base. This is rare for non-trivial projects. I'm not sure if it could be made as clear without those comments.
- Rapzid 5y agoAgree; could be very helpful if somebody not fam with token buckets arrives at this code for some reason and needs to make sense of it. Also, I think one person's "what" is another person's "why": > if self.one_time_burst > 0 { What is this code doing? It's setting up a flow control statement. It's dereferencing the "one_time_burst" property on the object self and comparing the value to 0. If the value is greater than 0, it will execute the proceeding code block. Why is this being done? > [to] consume the one-time-burst budget.