Documenting Code With Sandcastle

Documenting Code With Sandcastle - Part 2

The only change you would then need for this script is to put the names of the DLL's you actually want to document (ie replace alpha.dll beta.dll gamma.dll with your dll(s))... you may want to do this before running the batch file ;)
Copy and paste the script below into a text file make the dll name change on the first line sand save it as a batch file eg "documentation.bat". Save it in the same folder as your dll's and run it (click it).
This will give you an ultra generic help file, ala visual studio 2005 and all the rubbish .net 2.0 help files when it first came out.
I personally played with the xsl file to add in images etc to customise it a bit. i'm sure there are better ways to do it but i'm not spending any more time on some thing that i doubt anyone will ever read.
If you want them all spruced up, you probably want to check out the tools mentioned above.

EDIT: Sorry I fogot to mention that I dont name all of my XML Comment files ".comments.xml"!
I usually name them the same as my dll's with an xml extension eg alpha.dll has the comment file alpha.comment.xml. This means I had to make a change in the sandcastle config file (" C:\Program Files\Sandcastle\Presentation\vs2005\configuration\sandcastle.config " in my case) line 63 from
< data files=".\comments.xml" / >
to
< data files=".\*.comment.xml" />
to allow for all of the xml files to be a part of the help (which is what you really want now isn't it!).
EDIT 2:
To change the lines at the top & bottom of the main pages
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
&

Send comments about this topic to Microsoft.

Edit the shared_content.xml file found below.
C:\Program Files\Sandcastle\Presentation\*\Content\shared_content.xml

Back - Part 1 Next - Part 3

Expertise

Features

Documenting Code With Sandcastle - Part 2