How To Write Good C++ Comments. Here are some examples of bad line comments and good statement comments. All programming languages allow for some form of comments.
highlighting listings use different style for normal comments from tex.stackexchange.com
Over time, the code mutates away from anything resembling what the comments describe. // initializing the variable 'a' with the value 2. C++ comments start with /* and end with */.
Code That Seems Beyond Obvious Has A Funny Way Of Reading Like A Foreign Language After A Couple Of Months.
You should strive to remove clarification comments and simplify the code instead because, “good code is self. When to write a summary. /** comparison compare two types @param l type lhs @param r type rhs @return boolean result */ bool compare (type l, type r);
I Can’t Emphasize This Enough.
If you have to write comments, do not write about what the code is doing. Instead, write about why the code is doing what it's doing. Over time, the code mutates away from anything resembling what the comments describe.
In General, If You Can't Find Anything Specific To Point Out, Either The Code.
This will cause the contents of the comment to be ignored by the compiler. Write comments that you would want to read five years from now when you've forgotten everything about this code. The first and foremost principle of a good review is this:
It Is Used To Denote A Single Line Comment.
Often, a clarification comment is a code smell. This example goes same for c and c++ as the style of commenting remains same for both the language. It is idiomatic to have a.
The Doc++ Format Is Also Similer Like.
Here are some examples of bad line comments and good statement comments. Show activity on this post. You can create a comment that spans multiple lines.
