Re: An interview question
... That makes me wonder if Apple really pays attention to providing good code comments.
There are two conflicting views about putting comments into code, even though they do agree on the amount of commenting required:
1. "If it was hard to write, it should be hard to understand. Comments should be omitted."
2. "The code should be so clear that no comments are necessary. Indeed, comments generally tell what the programmer thought the code was doing, not what it actually does. They are thus misleading and should be omitted."
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
From our sponsor Doc-to-Help: Want to see a Doc-To-Help web-based Help sample with DISQUS for user commenting?
Learn more: http://bit.ly/13xpg5n
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com
Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.
Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com
Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives
References:
An interview question: From: Peter Neilson
Re: An interview question: From: phil stokes
Re: An interview question: From: Robert Lauriston
Re: An interview question: From: Keith Hood
Previous by Author:
Re: An interview question
Next by Author:
remove spaces from Word
Previous by Thread:
Re: An interview question
Next by Thread:
Re: An interview question
Search our Technical Writing Archives & Magazine
Visit TechWhirl's Other Sites
Sponsored Ads