Comments on: Comments Do Make a Difference http://awads.net/wp/2006/08/15/comments-do-make-a-difference/ News, views, tips and tricks on Oracle and other fun stuff Wed, 20 Aug 2008 17:40:59 +0000 http://wordpress.org/?v=2.5 By: Jalaj http://awads.net/wp/2006/08/15/comments-do-make-a-difference/#comment-51706 Jalaj Fri, 19 Oct 2007 05:24:59 +0000 http://awads.net/wp/2006/08/15/comments-do-make-a-difference/#comment-51706 It takes me less time to develop a fresh application than making heavy modifications to old one written by someone else for the same reason. comments do make difference. It takes me less time to develop a fresh application than making heavy modifications to old one written by someone else for the same reason. comments do make difference.

]]> By: Eddie Awad http://awads.net/wp/2006/08/15/comments-do-make-a-difference/#comment-48377 Eddie Awad Fri, 18 Aug 2006 22:40:02 +0000 http://awads.net/wp/2006/08/15/comments-do-make-a-difference/#comment-48377 <p>It seems that my spam firewall needs some tuning. Here is Sheeri's comment (lost in spam):</p> <p>Sheeri: Funny, in my organization there'd be a big ruckus about how it should be scalable, and "magic numbers" like those are often put in a database, so descriptive names and other metadata can be attached. Because there'd be 'make','buy', and then someone would want 'promised', and then someone would want 'almost' ......</p> <p>Eddie: I do not object to "magic numbers" as long as they are described and documented when used.</p> It seems that my spam firewall needs some tuning. Here is Sheeri’s comment (lost in spam):

Sheeri:
Funny, in my organization there’d be a big ruckus about how it should be scalable, and “magic numbers” like those are often put in a database, so descriptive names and other metadata can be attached. Because there’d be ‘make’,'buy’, and then someone would want ‘promised’, and then someone would want ‘almost’ ……

Eddie:
I do not object to “magic numbers” as long as they are described and documented when used.

]]> By: Eddie Awad http://awads.net/wp/2006/08/15/comments-do-make-a-difference/#comment-46489 Eddie Awad Wed, 16 Aug 2006 16:45:39 +0000 http://awads.net/wp/2006/08/15/comments-do-make-a-difference/#comment-46489 <p>Robert, for some reason, your comment was not posted, however, it was captured in <a href="http://www.cocomment.com/comments/Eddie" rel="nofollow">my cocomment</a>. So, here it is:</p> <p><a href="http://thinkoracle.blogspot.com/" rel="nofollow">Robert Vollman</a>:<br /> Did you talk to the original programmer? If so, what did s/he say:</p> <p>"What are you doing looking at my code?"</p> <p>"Oh yeah sorry. No big deal though."</p> <p>"I had to get this out the door, no time for comments. Just had to get something working."</p> <p>"Comments are a maintenance hassle - if I change the code I have to go change all the comments."</p> <p>Nothing, because s/he's long gone.</p> <p>Eddie:<br /> No, I did not talk to the original programmer because he is on vacation. But most likely, he will say one of the things you mentioned, except maybe "What are you doing looking at my code?".</p> <p>I have been guilty with leaving off necessary comments before. I believe it is a matter of habit and good practice.</p> Robert, for some reason, your comment was not posted, however, it was captured in my cocomment. So, here it is:

Robert Vollman:
Did you talk to the original programmer? If so, what did s/he say:

“What are you doing looking at my code?”

“Oh yeah sorry. No big deal though.”

“I had to get this out the door, no time for comments. Just had to get something working.”

“Comments are a maintenance hassle - if I change the code I have to go change all the comments.”

Nothing, because s/he’s long gone.

Eddie:
No, I did not talk to the original programmer because he is on vacation. But most likely, he will say one of the things you mentioned, except maybe “What are you doing looking at my code?”.

I have been guilty with leaving off necessary comments before. I believe it is a matter of habit and good practice.

]]> By: Karl http://awads.net/wp/2006/08/15/comments-do-make-a-difference/#comment-46031 Karl Wed, 16 Aug 2006 05:26:24 +0000 http://awads.net/wp/2006/08/15/comments-do-make-a-difference/#comment-46031 <p>i agree, always if possible use constants and as metioned where the optimizer could benefit comment and do not use them. Karl</p> i agree,
always if possible use constants and as metioned where the optimizer could benefit comment and do not use them.
Karl

]]> By: Gary http://awads.net/wp/2006/08/15/comments-do-make-a-difference/#comment-45875 Gary Tue, 15 Aug 2006 22:51:44 +0000 http://awads.net/wp/2006/08/15/comments-do-make-a-difference/#comment-45875 <p>Beware of constants as they are really variables (or at least they count as bind variables when it comes to SQL), which means you could end up with some unexpected cursor sharing. [Not saying that it is always bad, just that its something to be aware of.]</p> <p>Also, taken to the extreme it just looks silly. I've worked with code that had constants defined for Y and N (eg cv_y := 'Y'). And then you've got to remember whether cv_y is 'y' or 'Y' as the variables are case insensitive.</p> Beware of constants as they are really variables (or at least they count as bind variables when it comes to SQL), which means you could end up with some unexpected cursor sharing. [Not saying that it is always bad, just that its something to be aware of.]

Also, taken to the extreme it just looks silly. I’ve worked with code that had constants defined for Y and N (eg cv_y := ‘Y’). And then you’ve got to remember whether cv_y is ‘y’ or ‘Y’ as the variables are case insensitive.

]]> By: Eddie Awad http://awads.net/wp/2006/08/15/comments-do-make-a-difference/#comment-45515 Eddie Awad Tue, 15 Aug 2006 15:23:19 +0000 http://awads.net/wp/2006/08/15/comments-do-make-a-difference/#comment-45515 <p>Right, constants are very useful in this situation. In fact, I am going to have a separate post about PL/SQL constants soon.</p> Right, constants are very useful in this situation. In fact, I am going to have a separate post about PL/SQL constants soon.

]]> By: Tim Hall http://awads.net/wp/2006/08/15/comments-do-make-a-difference/#comment-45495 Tim Hall Tue, 15 Aug 2006 14:43:59 +0000 http://awads.net/wp/2006/08/15/comments-do-make-a-difference/#comment-45495 <p>Even better, us a constant with a suitable name :)</p> <p>Cheers</p> <p>Tim...</p> Even better, us a constant with a suitable name :)

Cheers

Tim…

]]>