Documentation from Comments in C#

Documentation is one of the hardest thing for a developer to do. Not because we don't understand what needs done. No that isn't it at all, it is because it is boring. However it is amazingly necessary. Have you ever written something down and dirty and then later have to go back and update it, and find that it takes 2 hours to figure out what you were thinking when you wrote that? I know I have. This is where C# comes in. More specifically C# in Visual Studio. In C# there is inline documentation. So if you comment as you code, you can actually build your documentation as you build your project. Here are some great links that explain it all very well

• Documenting C# with XML comments
• Using NDoc: Adding World-Class Documentation to Your .NET Components