4 ms·
I see so many examples with comments explaining “what” - given that you have to read code to truly understand what it does, comments must be maintained in addit
by zarathustreal 5y ago
I see so many examples with comments explaining “what” - given that you have to read code to truly understand what it does, comments must be maintained in addition to code, and comments can be either or both misleading and outright incorrect, isn’t it generally considered best practice not to write huge block comments at the top of a function implementation? Given these points, those kinds of comments are really just additional text the reader needs to parse through (to make sure they aren’t missing a meaningful “why” portion of the comment.)
Without circular reasoning (“we do it this way because it’s done this way”), can anyone provide some context here? Much appreciated!