Timeline for How can I deal with a team member who dislikes making comments in code?
Current License: CC BY-SA 3.0
14 events
| when toggle format | what | by | license | comment | |
|---|---|---|---|---|---|
| Feb 26, 2013 at 21:38 | comment | added | Henk Langeveld | @mehaase - Not what, not how, but why is the most important reason to add comments to code. | |
| Feb 20, 2013 at 18:42 | comment | added | jmk | @Paul I don't advocate adding comments where none are required, either; we all agree that the "add a and b" kind of comment is useless. But that's not an argument against comments, it's an argument against bad comments. | |
| Feb 20, 2013 at 3:04 | comment | added | DBlackborough | @Paul, different issue, developers not updating comments is not an excuse to not add them, educate the developers, don't just give up. | |
| Feb 19, 2013 at 0:10 | comment | added | Paul | @G3D I will disagree here, commenting on "where it will be used" is one of the wrong thing to do. One should never comment the intended usage - it does not guarantee it will not change and when it changes - people will 95% forget to update/remove the comment (hey, why would I need to touch this class if I just used it or its property in some other way =)) which will lead to issues later. | |
| Feb 18, 2013 at 23:45 | comment | added | Paul | @mehaase I don't find it to be helpful to hold anyone accountable for the issues that could have been avoided in the first place. I do agree that there are complex algorithms etc that need explanation, but those are very rear. If method size is 5-3 lines of code and it's "SRP-complaint" - I can hardly find a reason to add a comment to it, since its name will state what is the only thing this method is meant for. | |
| Feb 18, 2013 at 23:34 | comment | added | Paul | @jmk I was not saying "never" use comments, I suggested to get rid of all those, which one can. If comment can be removed via renaming/refactoring - that's the right way to go - those comments must not remain. | |
| Feb 17, 2013 at 13:20 | comment | added | Mark E. Haase | Silly. If the comments are wrong, then the person writing them should be held accountable. That's inexcusable. The purpose of comments is to explain what, not how. Your trivial example is trivial. Some real function will be more complicated and justifies at least one or two sentences about what it's there for and how it should be used. | |
| Feb 17, 2013 at 3:00 | comment | added | fluffy | @xaxxon Not to mention that apples even if that person might be you. | |
| Feb 17, 2013 at 2:32 | comment | added | xaxxon | The important thing to remember is that while everything makes sense to you right now, someone else will have to maintain your code in 3 years. Don't screw the over. | |
| Feb 17, 2013 at 0:56 | comment | added | DBlackborough | Yep, this is a silly suggestion, if the code is incredibly readable I could understand few comments but seeing comments should say why the method is doing what it is and where it will be used once you get to more than a few classes there really is no reason for no comments, they help everyone. | |
| Feb 16, 2013 at 22:27 | comment | added | jmk | This is just silly. I hope nobody believes that such poor commenting style is helpful. But do you honestly believe that comments should never be used? | |
| Feb 15, 2013 at 11:46 | history | edited | samthebrand | CC BY-SA 3.0 | Grammar, punctuation, word choice |
| S Feb 6, 2013 at 0:01 | history | answered | Paul | CC BY-SA 3.0 | |
| S Feb 6, 2013 at 0:01 | history | made wiki | Post Made Community Wiki by Paul |