Tuesday, October 2, 2012

About Sandcastle

Open source creator of documentation based on DLLs, EXEs and XMLs from .NET.
MSDN-Style API Documentation that can be made in CHM or regular HTML.

The original documentation before going to CodePlex is found here.
It use to need a companion HtmlHelper.

Sometimes if you choose Html2Help files, install it from here.
There is a viewer here.
An error can happen as BE0038: Could not find the path the MS Help 2 compiler.

You can also isntall Windows Installer XML (WIX) Toolset here.

Reboot in CodePlex

Sandcastle is hosted in open source space here. Install the *.msi file.
It will be installed on folder C:\Program Files (x86)\Sandcastle\
Verify that its environment variable is properly set DXROOT to C:\Program Files (x86)\Sandcastle\
SandcastleStyles is an upgrade found here. Install the guided installer plus the tools source code.
SandcastleHelpFileBuilder is the companion found here.
It will be installed on folder C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\
Verify that its environment variable is properly set SHFBROOT to C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\
Verify that its environment variable is properly set LANGUAGES to %SHFBROOT%\SandcastleBuilderGUI.exe

Create, compile, document

In your solution/ project you create your files, compile them in order to have DLLs and EXEs.
Documenting the code beforehand with other tools help.
Configure VS to create XML documentation from it.
You can also use the command prompt:
>%SystemRoot%\Microsoft.NET\Framework\v4.0.30319\csc.exe /target:library /doc:Guy.xml Guy.cs
>%SystemRoot%\Microsoft.NET\Framework\v4.0.30319\msbuild.exe Guy.shfbproj

No comments:

HTMLCode

HTMLCode Content