OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.


Help: OASIS Mailing Lists Help | MarkMail Help

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

RE: Comments

A road is self-documenting.

You need to get to the airport BEFORE the 
flight leaves?  Oh, well, I have this map.  I authored 
it.  I published it.  I'll sell this to you.

A tax form is self-documenting.

Of course my neighbor's children 
are my dependants.  I mean, they eat here 
at least three times a week.  I am supporting 
them, right?

Lifeboats are eXtremely self-documenting?

Didn't you read the instructions?  I'm sorry 
but YOUR deck goes into the starboard...GLUG!

Whee.  Better than Haikus.


Ekam sat.h, Vipraah bahudhaa vadanti.
Daamyata. Datta. Dayadhvam.h

-----Original Message-----
From: Danny Ayers [mailto:danny@panlanka.net]

But what about the Xtreme view of good code being self-documenting? - if
your code needs comments then your naming/structuring is at fault. Ok, this
*is* the extreme case, but it's a reasonable point - you should be able to
tell what a thing is/how to use it/if it bites without needing a manual.