lua-users home
lua-l archive

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

> Good comments explain what the code is doing, and why - not how.
> (That's what the code is for.) You should be able to understand the
> code months later when all those clever tricks are no longer fresh in
> your mind.


I have a grudge against the usual coders arguments "good code does not
need to be commented, because it explains itself", pah! A single
*english* line per function/file that explains what the function does
or what the collection in this file is for makes diving into a source
base so much easier.

About YES NOPE9 question. It depends on the coder not on the language,
all language are equal to this, only difference maybe how easy you can
generate other documents out of the inline comments.