GhostDoc is a great little tool, originally written by Roland Weigelt, which helps you to maintain the XML documents in your code. You can download it from its new home at SubMain, the Developer Tools Division of vbCity.com, LLC.
I'm sure you've seen those great-looking comments preceded by the /// in C# or the ''' in VB.NET, that once written, will provide not only us but anyone else that uses our code IntelliSense information.
Take, for instance, our method to get the roles for a user:
public override string[] GetRolesForUser(string UserName)
Taken out of context, this doesn't really tell us much about what the method does. However, if we add some XML documentation to it, it can be much more informative:
/// <summary> /// Retrieves a string[] of Roles for a user with given UserName /// </summary> /// <param name="UserName">The login name of the user</param> /// <returns>string[] of role names</returns> public override string...