Comments on: Inline XML Code Documentation using Sandcastle

By: Scott Nichols

Scott Nichols — Wed, 02 Apr 2008 21:05:49 +0000

Yeah, I do not think it is necessary to spend tons of time making your XML comments picture perfect either. Okay, one exception, if you are developing commercial software such as a control library. I think the extra effort spent in your XML comments could payoff in more sales because of better API documentation, possibly.

I would just like to see more people use XML comments (even if they take the minimalist approach) then take a tool like Sandcastle to generates docs. Over the years I have found if someone had generated API documentation I could come up to speed on their API exponentially faster, especially if they made go use of my favorite tag the …

The description of the example
Some source code showing how to use your class, method, etc…

By: trasa

trasa — Wed, 02 Apr 2008 16:32:46 +0000

One thing I’ve done differently recently: I used to spend a lot of time making my XmlDocs look good in .chm or html format (processed via ndoc), using a tool like Documentor to view the output in visual studio.

But then this makes the comments less readable in the source code – arguably the most important place to read them! So I still use XmlDocs and GhostDoc to help with some of the boilerplate, but I don’t worry too much about formatting the xml within with and and so on.

By: Dew Drop - April 2, 2008 | Alvin Ashcraft's Morning Dew

Dew Drop - April 2, 2008 | Alvin Ashcraft's Morning Dew — Wed, 02 Apr 2008 13:44:59 +0000

[...] Inline XML Code Documentation Using Sandcastle (Scott Nichols) [...]

By: Tobi

Tobi — Wed, 02 Apr 2008 07:42:55 +0000

A couple days back Alex published a step by step howto about setting up sandcastle. Check it out:

http://saftsack.fs.uni-bayreuth.de/~dun3/archives/integrate-xml-code-comments-into-visual-studio-20052008-using-sandcastle-and-html-help-20/150.html

By: Reflective Perspective - Chris Alcock » The Morning Brew #64

Reflective Perspective - Chris Alcock » The Morning Brew #64 — Wed, 02 Apr 2008 06:27:56 +0000

[...] Inline XML Code Documentation using Sandcastle – Scott Nichols gathers together a collection of links for XML documentation and using SandCastle [...]