re: Is Commenting Code that necessary? VIEW POST


It's language/framework dependant and the old "Comment everything" is… getting old and poked fun at.

Modern languages, framworks and overall practice makes code much, much easier to read and understand. But I remember scientific code in C (or crazy ad-hoc languages): they are cryptic at best. So descriptive comments were necessary to decipher the thing.

For modern JS, Rails, Python etc. they should be only for the non obvious part and focus more on the "why". Typical exemple include what is returned by a required module or library, or why you wrote that helper function where it is used etc. But descriptive comments like "this function does that" should be a warning, if anything.


Yes. Exactly even I meant to say it !!
Identification of right places and intent to write a comment and keeping it clean and informative (like u mentioned in the last lines) is important...
Thanks for this comment :)


By the way I forgot, but a good README also greatly reduce the necessity for comments.


Yeahh .! 👍 It must clearly give the view of entire project!!

code of conduct - report abuse