Timeline for How to avoid falling into the trap of not commenting code?
Current License: CC BY-SA 3.0
5 events
| when toggle format | what | by | license | comment | |
|---|---|---|---|---|---|
| Jun 14, 2017 at 21:36 | comment | added | Martin Maat | @Bender In my answer I was talking primarily about class member documentation. In code bodies you will often have several blocks that represent steps in the logic. You could briefly comment each block and the comments together should tell the method's story. Ideally you would start by writing these comments in an empty code body, thus setting the stage for your implementation and then insert the code blocks. | |
| Jun 14, 2017 at 21:07 | comment | added | Ubernator | Thanks. It is hard to figure out what lines are and are not worth commenting on, I feel as though if I added to many comments the actual code page would be 50% code and 50% comments. Your advice will help me continuing developing this project further. | |
| Jun 14, 2017 at 21:04 | vote | accept | Ubernator | ||
| Jun 14, 2017 at 19:13 | history | edited | Martin Maat | CC BY-SA 3.0 | added 116 characters in body |
| Jun 14, 2017 at 19:08 | history | answered | Martin Maat | CC BY-SA 3.0 |