| ??? 07/20/09 10:06 Read: times |
#167587 - Properly documented code Responding to: ???'s previous message |
Per Westermark said:
You are wrong if you make it so simple as believing that variable names and function names will remove the need for comments. If you want an example of well-commented code, take a look at Karas's Keypad Scanner Code In C In particular, look at the block comment at the top of the listing that gives an overview of what the code does. Similarly, block comments above each function give an overview of what the routine does; even though meaningful function names are used, those names alone are not sufficient! Note also that each variable definition is accompanied by a descriptive comment; even though meaningful variable names are used, those names alone are not sufficient! |
| Topic | Author | Date |
| Keypad interface problem: My code not working.. | 01/01/70 00:00 | |
| Check in a simulator | 01/01/70 00:00 | |
| RE: | 01/01/70 00:00 | |
| Care for details | 01/01/70 00:00 | |
| Formatted code | 01/01/70 00:00 | |
| RE: i dint check the bounce | 01/01/70 00:00 | |
| Bounce vital to think about | 01/01/70 00:00 | |
| Do document | 01/01/70 00:00 | |
| re: documentation prob | 01/01/70 00:00 | |
| Fixing prob: | 01/01/70 00:00 | |
| Did you search? | 01/01/70 00:00 | |
| RE: the search tool here is not the most powerful | 01/01/70 00:00 | |
| Karas's Keypad Scanner Code In C - detabbed | 01/01/70 00:00 | |
| Properly documented code | 01/01/70 00:00 | |
| Reasons and assumptions | 01/01/70 00:00 | |
| Per, you implied, but did not say | 01/01/70 00:00 | |
| dangerous loops | 01/01/70 00:00 | |
| code??? | 01/01/70 00:00 | |
| RE: now am modified my code | 01/01/70 00:00 | |
| How to post legible source code | 01/01/70 00:00 | |
| unfortunately, that does not add comments | 01/01/70 00:00 | |
| re: thanks now i got how to insert code | 01/01/70 00:00 | |
| Scanning Keypad | 01/01/70 00:00 | |
How to scan Keypad | 01/01/70 00:00 |