XML Comment Documentation Guide

posted on 12/09/07 at 08:44:32 pm by Joel Ross

I've seen quite a few posts about XML documentation guidelines, but this is by far the best I've seen thus far. It goes a step further than any I've seen - it specifically highlights what is supported by Visual Studio, NDoc, and Sandcastle, so you can make good decisions about the type of comments you can - and probably add more documentation than you normally would because you know about it.

It's not a small document though - it's 67 pages! If you followed all of the guidelines here, your documentation could be great.

Tags: | | |

Categories: Development, Software, C#