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

At 2:33 Uhr -0500 27.08.2003, Bryan Pietrzak wrote:
And with modern syntax coloring, isn't it just easier to skim the blue colored functions and whatever-colored types and constants? (You do have all of your carbon symbols entered as a custom keywords right? It's easy to do and very helpful!)

It isn't. I'm stuck with Project Builder :-(

I've worked in team environments for the past decade and I can say without a doubt that it's much easier to read and understand "clean" code with no comments than it is to wade through "messy" (of course, 'messy' is my definition ;) code with lots of comments from half a dozen different people with initials and dates and version numbers and whatnot and have 75% of the comments just be flat out wrong.

Well, I guess if your programmers did what I'm lobbying for, you wouldn't have that problem. Because I (re-)write the comments whenever I change anything in the code. And I think you should teach programmers the importance of comments (*and* sensible variable names, *and* self-documenting code), instead of working towards their lazyness by ripping out the comments they write.
--
Cheers,
M. Uli Kusterer
------------------------------------------------------------
"The Witnesses of TeachText are everywhere..."
http://www.zathras.de
_______________________________________________
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.
References: 
 >Re: [OT] Commenting source code (From: Bryan Pietrzak <email@hidden>)



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.