views:

962

answers:

3

Is SandCastle the best "free" code document producing tool? Or Is there a more recommended product, that works with .net?

+9  A: 

It is my preferred documentation tool, regardless of price. Note that SandCastle, by itself, offers a nice set of features. However, you will gain much more value from it by using something like the Sandcastle Help File Builder project from Codeplex. I have been using the 1.8.0.0 Alpha release for a couple of weeks now, and it is miles ahead of the 1.7.0.0 version posted, too.

I also recommend GhostDoc for comment templating and inheritance.

joseph.ferris
Joseph, can it output HTMl with a navigation frame?
Michael L
Yes, it can. It can produce help web sites, and not just CHM files. We use both. We publish the site to a "help" server in-house, and distribute the CHMs, as needed.
joseph.ferris
I have to tell you Joseph, the help builder plugin makes the project great, thanks again for the info!
Michael L
Not a problem. Glad to help! I know that it has made my life a lot easier.
joseph.ferris
+6  A: 

I've never used SandCastle, but I've gotta put in a vote for Doxygen. It's got support for a lot of languages & environments, but as I only use it for (unmanaged) C++, I can't vouch for its .Net support.

Drew Hall
+2  A: 

I agree with Joseph.

I downloaded the SandCastle SDK and found it a pain to work with. Then, I downloaded the Help File Builder. It works just like NDOC, which is what I was looking for.

Jim Anderson
!Agreed! Same experience
Michael L