Jeremy White jwhite@codeweavers.com writes:
Okay, so it's a slow news day, and I feel like stirring up trouble.
Bad boy...
I would argue that it is, in fact, counterintuitive, to have this sort of comment solely in the change log. The only time I ever think to look at a diff (or even the change log) is when something has broken recently.
Well, because *you* don't look at it doesn't mean it's not the right place, does it? <g> I look at the CVS history quite often, and I find that in many cases it's the best way to find out why things are done a certain way.
I don't see any reason to duplicate this info inside the code itself; since we are using a source control system we might as well take advantage of it. Plus it guarantees the info is stored permanently, unlike a comment that may get moved or lost next time the code is changed.
Well, because *you* don't look at it doesn't mean it's not the right place, does it? <g> I look at the CVS history quite often, and I find that in many cases it's the best way to find out why things are done a certain way.
Ah, but I suspect that I am more representative of the typical hacker than you are, in this regard. Further, attempting to comprehend the changelog without the context of the relevant source code is generally unrewarding for me.
However, I think I realize that my post and thread is largely useless. As much as I think you err on the side of brevity, I suspect that, except for my patches, you rarely go around deleting comments from code...
Jer
-
Alexandre Julliard -
Jeremy White