Comments in code: best practices and 4 mistakes to avoid

In computer programming, comments in code are used to include information on portions of source code in a project. Code comments are intended to make the related code easier to understand by providing additional context or explanation. Code comments can … See more

CouponFollow Extension

FAQs about Comments in code: best practices and 4 mistakes to avoid Coupon?

Is commenting a readable code a bad idea?

No. The purpose of the others rules you talk about is precisely to avoid that. Comments to a readable code are at best redundant, and at worst will throw a reader off looking for the non-existent purpose of the comment. If you comment whole code which is self-explanatory, you double the amount of reading with out giving any additional information. ...

Should you leave a comment in a codebase?

Do not leave it hanging in the codebase as a comment. If you need the out-commented code in the future, you should use version control. This is one of the countless benefits of version control. You can travel back in time to inspect and revive old pieces of the code if needed. ...

When should I drop a comment?

Drop comments anytime you hit a place where the code isn't immediately clear. For example, describe the class when the class name isn't clear or could be interpreted too widely. Another example is if I'm about to write a non-obvious code block, I'll first add a comment reminding me of what I want/need. ...

Should I comment or not comment code?

Also, sometimes when you are not the owner of a piece of code, you should add a legal note at the top of the code file. Commenting code is unnecessary. But occasionally, it is needed. Here is a list of best practices on commenting and not commenting code. ...

Should you leave comments on code?

Instead of commenting on code, rewrite it! The code should always be clear enough to express itself. On rare occasions, however, code comments are necessary. This guide teaches you the best practices for leaving and not leaving comments in your code. After reading this guide, you understand when using and not to use comments. ...

Should code comments be used in a sentence?

A code comment is useful only if it: Clarifies out-of-sort code that is needed for business purposes. Is used to disclose the legality of the piece of code. Basically, in all other cases, code comments are bad. To put it in one sentence, avoid code comments altogether. Use them only if they are absolutely necessary. ...