Documenting Private Methods

At my current contract, I've done three brand new applications from scratch and have been involved in modifying a couple of others.  Every developer has their own coding style and it can be sometimes difficult to come up to speed on how someone else has decided to code a particular application.  What I've found myself doing more and more is documenting (using XML comments) the private methods of these apps I need to modify.  When I find a method and the name isn't descriptive (to me) as to what it is doing, I jump to it, review the code to see what it's doing and then add an XML comment for the method.  The next I run into a call to this method, Intellisense will pop up my summary description and I won't need to leave my current spot.  This gets me up to speed quicker on how the app is architected and makes it quicker for me to do my modifications.

So now I'm trying to do this to my own applications as I go back and modify them.  This way, the ramp-up time for another developer to be able to modify my code should be reduced.  Anyone else document their private methods?

No Comments