Introdução

Este manual explica como instalar e utilizar a aplicação SandCastle Help File Builder (SHFB) de modo a gerar documentação das assemblies que geramos.

O que esta aplicação faz é pegar numa DLL e pegar no XML dos comentários associados aos métodos, classes, namespaces e propriedades, e colocá-lo num repositório user-friendly.

Instalação

Passo 1: Aceder ao site http://shfb.codeplex.com/documentation e escolher o link Latest Release.

Passo 2: Fazer download do pacote de instalação com a última versão.

Passo 3: Extrair o conteúdo do ficheiro .zip e abrir a pasta.

Passo 4: Executar o instalador SandcastleInstaller.exe.

Passo 5: Caso o Microsoft Help 2 compiler não esteja instalado, prosseguir com a instalação.

Passo 6: Instalar o SHFB.

Passo 7: Instalar o package para o Visual Studio (2010 / 2012 / 2013).

Passo 8: Instalar os schemas MAML (para intelisense).

Passo 9: Instalar os snippets MAML.

Prosseguir até ao fim da instalação.

Passo 10: Criar um documento batch com o seguinte conteúdo:

set DXROOT=c:\Program Files (x86)\Sandcastle
set SHFBROOT=c:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder
set LANGUAGE=
"%SHFBROOT%\SandcastleBuilderGUI.exe"

Este batch arrancará o GUI do SHFB.

Criação de documentação

Passo 1: Executar o documento batch criado na instalação.

Será aberta a aplicação SHFB.

Passo 2: Criar um novo projecto (Start a brand new project).

Será mostrada a estrutura do projecto:

Passo 3: Escolher os formatos de help file a gerar, a framework, etc.

Passo 4: Adicionar DLLs e XMLs como origens de documentação (Documentation source).

Passo 5: Gerar o help file.

Referências

1. http://broadcast.oreilly.com/2010/09/build-html-documentation-for-y.html
2. http://shfb.codeplex.com/documentation