Code Comments
Code Comments
- Subject: Code Comments
- From: Dov Rosenberg <email@hidden>
- Date: Tue, 15 Aug 2006 22:24:16 -0400
- Thread-topic: Code Comments
Title: Code Comments
Like usual the threads have been hijacked from their original purpose. I just thought I would throw my 2 cents in about code comments:
We have a team of 3 developers working on our application. Instead of having 1 person specialize in one area of our application, each programmer works on a wide variety of tasks usually working on an area where someone else has worked before. It is our form of code review and works pretty well.
I have told the guys that I don’t need to see comments that explain what I can read. I want comments that explain WHY we are doing things the way we did. If you look in our code you will see little explanations of the conversations that we had about a particular feature usually along with a date and initials. That way when the next guy looks at the code they have a bit more context as to why something was done versus what was done. This becomes helpful is explaining how a feature works when someone goes to write documentation sometime in the distant future or when trying to debug some cryptic logic.
Design by contract is great for code compile and runtime checking but still doesn’t explain the mental state (or lack of) the dude working on the code that day.
--
Dov Rosenberg
Conviveon/Inquira
Knowledge Management Experts
http://www.conviveon.com
http://www.inquira.com
_______________________________________________
Do not post admin requests to the list. They will be ignored.
Webobjects-dev mailing list (email@hidden)
Help/Unsubscribe/Update your Subscription:
This email sent to email@hidden