| ??? 02/22/09 18:37 Read: times |
#162648 - Document "why" instead of "how" Responding to: ???'s previous message |
I normally call this: Document "why" instead of "how".
Only the header for a complex algorithm would need a "how" section for the algorithm as a whole. But a C construct or an assembler instruction never requires a "how" - a reasonably competent programmer (or actually anyone who calls themself a programmer) should understand an assembler instruction or a line of C code. Comments should help the reader to understand the code, but not be noise that takes the focus from the problem. |
| Topic | Author | Date |
| edge-triggered interrupt | 01/01/70 00:00 | |
| no throrough analysis, but | 01/01/70 00:00 | |
| edge triggered interrupt | 01/01/70 00:00 | |
| you need to read "the bible" | 01/01/70 00:00 | |
| I did | 01/01/70 00:00 | |
| edge triggered interrupt | 01/01/70 00:00 | |
| already answered | 01/01/70 00:00 | |
| edge triggered interrupt | 01/01/70 00:00 | |
| Need better comments | 01/01/70 00:00 | |
| Document "why" instead of "how" | 01/01/70 00:00 | |
| Clear Interrupt flag before enabling interrupt | 01/01/70 00:00 | |
| still imprecise | 01/01/70 00:00 | |
| Some thoughts... | 01/01/70 00:00 | |
the remaining part of the program | 01/01/70 00:00 |