I found out that if you are trying to determine how to use SandCastle, download DocProject too. It utilizes SandCastle and provides a user interface and a Visual Studio Project type template. Sandcastle alone does not.
You then Add a new project (DocProject) to your solution and can generate .HXS (using help compiler 2.0) or .CHM (using help 1.1).
HTH,
Nikos
by
NYannios on
Jan 2 at 4:14 PM
It might be good, but does not work with 2008 to say mothing about 2010. Gui even does not start,
by
elbertlev on
Dec 4 2009 at 12:27 AM
Immediately uninstalled after install. If it's not obvious how to use this, you've lost me as a user.
by
rgerard on
Dec 1 2009 at 10:47 PM
5 stars for the product, excellent job! 2 stars for documentation and average user oriented tools.
by
RomanKuzmin on
Nov 18 2009 at 7:18 PM
No documentation about using Sandcastle here nor in the installed files. Somewhat good introduction to Sandcastle is in DocProject for Sandcastle but it would be nice to see something about this project here.
by
izsak on
Nov 17 2009 at 11:05 AM
EPIC FAIL -- How do you use this? Where is the documentation? Why isn't the documentation for this tool built using the tool (dogfooding)?
by
AdrenalineWerks on
Nov 12 2009 at 5:24 PM
This tool is a must for .Net developers along with a companion product such as DocProject for easier Visual Studio integration. Documentation should be forward-push, not a task relegated to the end of the project when maybe there will be some spare time (but probably not). Instead, create documentation while you code, then let Sandcastle and DocProject do the heavy lifting.
by
NameOfTheDragon on
Aug 24 2009 at 5:14 PM
It's really a good idea and an excellent product. I would like to introduce it to my friends :)
by
awachen on
Jul 31 2009 at 1:58 PM
Sandcastle is an excellent tool that I use on a regular basis to generate help documentation. To set it you need help file builder at http://www.codeplex.com/SHFB/Release/ProjectReleases.aspx?ReleaseId=9848
by
TATWORTH on
Jul 27 2009 at 4:55 PM
This is a great product. Of course, being command line-based you need to have some technical skills to use it properly (for example using MSBuild in Visual Studio). I can't wait for it to be fully integrated to the development environment (hopefully it will happen, eventually).
by
SDolha on
Jul 7 2009 at 6:33 PM
Although the product does a good job, documentation on how to use it is lacking.
by
mgbrown on
Jul 6 2009 at 3:46 PM
This is the 2nd time I've tried sandcastle. Obviously I am missing something. The learning curve required for this is ludicrous! It should be as simple as: here is the code with comments, generate me the documentation.
Where is the quick start on how to do that???
by
cmroanirgo on
Jun 23 2009 at 2:06 AM
Could not get it to work, and no documentation.
by
babairo on
Jun 19 2009 at 6:25 PM
Works fine for me
by
markhor on
Apr 9 2009 at 9:48 AM
Excellent feature set and good documentation. Integration to VS major plus. Make sure you get the essential shfb.codeplex.com GUI.
Only drawback: reeeeaaaaally slow... Brand new quad-core w/ RAID-0 disk setup still crawls, can't see why since CPU usage and disk access is low.
by
i96danma on
Apr 3 2009 at 2:36 PM
Really useful, very handy. Get the Sandcaste HelpFile Builder, too.
by
Cheeso on
Apr 2 2009 at 12:55 AM
It's one of Microsoft's really useful products.
by
gerald_jk on
Mar 6 2009 at 1:40 PM
Please do something about the memory (ab)use of BuildAssembler. For my 70k-Lines-Project it uses 750Mb of mem on a recent 4GB-machine and is terrible slow due to thrashing. The docu-build (using the sandcastle help file builder) needs 12 minutes - the rest of the build-process needs ca.30 sec (including building the install set.)
by
Gulli8 on
Mar 4 2009 at 10:20 PM
Just works and does something incredibly useful since the raw XML output of the compiler doesn't help much. I do recommend using Sandcastle Help File Builder though. And to danpeay: Don't give a documentation compiler one star because it doesn't edit chm files (just to be clear: it's not supposed to).
by
dcdietrich on
Feb 15 2009 at 1:03 PM
This project is very useful. We've used it to create documentation for several projects in Patterns & Practices, such as Composite Application Library (Prism) and Web Client Software Factory. There is still some room for improvement in flexibility and styles. Keep up the good work.
by
juliandominguez on
Feb 11 2009 at 1:50 PM
The rampup is steep, so get SandCastle Help File Builder. This is a very promising framework. Once integrated in VS via SHFB it will become a defacto standard.
by
dblock on
Dec 15 2008 at 12:41 PM
I just want to change a few things in a chm file. I can't figured out how this will help me.
by
danpeay on
Oct 31 2008 at 10:19 PM
This is insanely complex for what's needed, converting XML into HTML.
by
Grauenwolf on
Oct 15 2008 at 6:45 AM
Good stuff but you really need to merge the changes from the Sandcastle Styles project into the main Sandcastle release to fix the bugs and add the new features from it.
by
Slartibartfast on
Aug 29 2008 at 6:44 AM