??? 05/20/10 10:02 Read: times |
#176062 - Please remove baby from bathwater before disposal! Responding to: ???'s previous message |
Jez Smith said:
The golden rule is:- only put comments in your code when its not clear what is going on,or there is some non-obvious side effect, nothing else Yes, you can go too far with comments so that you "can't see the wood for the trees" - but I think you're going to the opposite extreme there! I don't need to be told that a clock signal is a clock. But how do you know it's a clock if you're not told?! |
Topic | Author | Date |
When comments go wrong | 01/01/70 00:00 | |
Always document what the code is doing or the weather | 01/01/70 00:00 | |
do you have some examples of that? | 01/01/70 00:00 | |
I've never seen anything like that ... | 01/01/70 00:00 | |
Do it like a pro. ;) | 01/01/70 00:00 | |
the dubious value of comments | 01/01/70 00:00 | |
RE: not subject to any scrutiny of the compiler | 01/01/70 00:00 | |
limited vocabulary | 01/01/70 00:00 | |
dubious | 01/01/70 00:00 | |
Please remove baby from bathwater before disposal! | 01/01/70 00:00 | |
Good selection of symbol names helps a lot | 01/01/70 00:00 | |
variable/function names can be misleading too | 01/01/70 00:00 | |
RE: the word Andy will be so kind to supply... | 01/01/70 00:00 | |
Well | 01/01/70 00:00 | |
Dodgy premise | 01/01/70 00:00 | |
That's no fun. | 01/01/70 00:00 |