Wednesday, September 30, 2015

.NET Code Documentation

Although good naming and a set of well written tests  can bring us so far, good documentation is sometimes indispensible.

Before releasing a component I was documenting a public API using the Visual Studio XML documentation. The exposed API was using generics, but I didn’t know what the correct documentation structure was.

MSDN brought the answer:

2 comments:

Kristof Mattei said...

I use GhostDoc for this, it's very easy to give you that initial 'stub' for your documentation.

Smith Cole said...

Hi, Nice update. I have a little bit idea about .net when I hosted my website on Myasp.net.But now I get something about code documentation after reading this blog. Thanks for sharing and keep blogging new updates like this.