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 22:29 -0400 29-08-2003, Laurence Harris wrote:
On 8/29/03 8:16 PM, Camillo Lugaresi didst favor us with:

At 16:45 +0200 28-08-2003, M. Uli Kusterer wrote:
Not to mention that C identifiers are usually named in English (so
they fit in with the ANSI library's name), while comments are almost
always written in the native language of the author.

Ugh. That's so awkward! Comments ought to be written in English too.

I think identifiers should be in French accompanied by comments in English
and at least one other major language.

Okay seriously, if you're going to write comments, they should be written in
the language in which you can communicate most effectively unless you know
there will be people reading who need another language. I can't begin to
think of a faster way to make comments useless than to write them in a
language in which you aren't fluent. This goes back to my position that a
comment which doesn't clarify anything is useless.

My implicit premise was that you have to know English to be in this industry, so you should be able to write comments in English. If you are not very fluent yet, consider it an exercise that will prove useful in the future. The added difficulty should also discourage you from writing unnecessary comments. ;D

Camillo
_______________________________________________
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: Laurence Harris <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.