Mailing Lists: Apple Mailing Lists
Image of Mac OS face in stamp
 
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

RE: [OT] Commenting source code (was Re: Problems with Controls M anager)

Experience. Trust me. They will get out of sync, I guarantee it and will
wager money on it. I've seen it too many times to believe otherwise :)

Laziness has nothing to do with it. More often than not it's deadlines.
Though in the past it's also been the case that refactoring was somewhat
frowned upon: you simply didn't touch other people's code any more than you
had to. But, that's another topic. :)


Bryan
> ----------
> From: Diego Rey
> Sent: Wednesday, August 27, 2003 11:05 AM
> To: Apple Carbon Development
> Subject: Re: [OT] Commenting source code (was Re: Problems with
> Controls Manager)
>
> Well, self documenting code sounds better now, so I'll give it a try.
> It'll
> take me some time to learn how to achieve it but thanks for the good tips.
>
> > Yeah, "theory of operation" documents/comments are important, but again
> > when the get out of sync they end up causing more harm than good.
> >
> > Bryan
>
> Hmmm, just one note. I really think that keeping the comments in sync is
> just a matter of getting used to it. I for instance am new to C++ and
> MacOS
> development but when coding with other languages I got always used to
> writing code and reviewing the comments and they never got out of sync.
> Even in the projects that I shared with other people.
>
> I don't think that it's fair to say that comments tend to get out of
> sync...
> in my opinion it's just about lazyness there.
>
> But yes, a clean code maybe is better than loads of comments.
_______________________________________________
carbon-development mailing list | email@hidden
Help/Unsubscribe/Archives: http://www.lists.apple.com/mailman/listinfo/carbon-development
Do not post admin requests to the list. They will be ignored.


Visit the Apple Store online or at retail locations.
1-800-MY-APPLE

Contact Apple | Terms of Use | Privacy Policy

Copyright © 2007 Apple Inc. All rights reserved.