Personally I write xml comments on all my methods even though I am a fan of method names enough describing that comments really are unnecessary. By descriptive method names I mean that others also understand them.
In a project I stumbled upon this method:
private void ShowHideControl( bool truefalse ){...
Since I had the source code it didn't take much effort to find out what it did.
But a question remains - how do I present the problem for the original programmer without being rude?
No comments:
Post a Comment