|
"If you can say it in code, do so. If you can't, say it in a comment."
Software Zen: delete this;
|
|
|
|
|
Those who can do code.
Those who can't teach comment.
Just kidding, kind of... 
|
|
|
|
|
Those who don't comment, suck.
Software Zen: delete this;
|
|
|
|
|
I always comment my code, this helps the new person to understand the code easily.
Sometimes, I also comment when I have to visit the code after the testing is complete. Different scenarios are kept with comments so as to remove the unwanted code at the end.
|
|
|
|
|
Ok, how do you select "I just throw random comments at the code view and see what sticks" out of those selections?
|
|
|
|
|
Funny but true...
I hardly write any comment in my code, but I comment the code itself when I am planning to delete it in future after proper testing of new code. 
|
|
|
|
|
I've made a habit of commenting my code thanks to CodeProject. Preparing a source code for an article to be published in CodeProject is not exactly same as developing an end-user application. Readers may read the entire code and tried to understand line by line so comments are mandatory. Based on the viewers questions and suggestions for previous articles, I could decide what exactly should comment in the code of next article.
|
|
|
|
|
If I am in a good mood, I will comment legacy code saying, //fixed joe 05052014.
Then if I have some very complicated business logic that was not documented well, I will try to comment a decent explanation of what is going on.
Otherwise, my naming conventions and KISS Principal should explain the code.
|
|
|
|
|
Then there's the commenting on the comments made on questions regarding code commenting.
Though, when asked if I commented on a comment when that comment made of which was commented on was a questionable comment, I give the standard reply:
"No Comment."
|
|
|
|
|
I initial and date my comments as a matter of habit... Many times has it saved me from the Spanish Inquisition!! (Look, the last time this function changed was 6/5/2008 - it can't have suddenly caused the problem you are referring to!!)
|
|
|
|
|
_Damian S_ wrote: it can't have suddenly caused the problem you are referring to
You wouldn't believe how many times that has not been true for me. The problem is every piece of code relies on a certain set of assumptions. Over time, as operating systems or hardware changes, those assumptions may no longer be valid. Code that worked may stop working or break in subtle ways. Multi-threaded code is my favorite example. I've had code that worked correctly in a single CPU environment break when Hyperthreading was introduced, and then broke again in a multi-processor environment.
Software Zen: delete this;
|
|
|
|
|
Yeah, fair point... I work on fairly run of the mill business apps though, so I would have to be super-unlucky to be shafted like that... but it will come!!
|
|
|
|
|
That;s what source control and a 'blame' function is for!
|
|
|
|
|
I try to make all my code DoxyGen compliant.
Along with Antimatter and Dark Matter they've discovered the existence of Doesn't Matter which appears to have no effect on the universe whatsoever!
Rich Tennant 5th Wave
|
|
|
|
|
|
From Confessions of a bug addict[^] : I try to write the comments when I am assembling the code fresh from a good night's sleep that I will be thankful for when debugging that same code at 03:30am when something has blown up.
|
|
|
|
|
Please see pet peeve #1 in this[^] article.
/ravi
|
|
|
|
|
I remember 
|
|
|
|
|
How about the...
I try to write code that will comment itself??
or
I only comment code when the code itself isn't already self documenting.
|
|
|
|
|
I go for a minimalist approach. Too much comments just get in the way and make the code harder to read and I really hate "captain obvious" comments:
float GetSpeed() const
void SetEditMode(int editMode)
|
|
|
|
|
The code base I am using has comments like this:
con.Open();
I remove them whenever I come across them.
There are only 10 types of people in the world, those who understand binary and those who don't.
|
|
|
|
|
Really makes you question the reasoning ability of the coder when you see statements like that.
|
|
|
|
|
You forgot to explain what "con" is in your comment 
My plan is to live forever ... so far so good
|
|
|
|
|
Commenting for the sake of commenting... not that there is any value
|
|
|
|
|
More minimalist
float GetSpeed() const
void SetEditMode(int editMode)
But I prefer the below one because the first two method names are good enough to understand the purpose. See the 3rd method
float GetSpeed() const
void SetEditMode(int editMode)
void MeaninglessMethodNameBySomeone(int editMode)
|
|
|
|
General 
News 
Suggestion 
Question 
Bug 
Answer 
Joke 
Praise 
Rant 
Admin 
Submit an article or tip
