Automatiza el proceso de documentación.
Permite crear .chm y .html de la documentación que hay
incrustada en el código de proyectos, de estética muy similar al MSDN.
Instalar Sandcastle
Instalar
el “Sandcastle Help File Builder”
Para escritorio: Añadir el
proyecto/solución.
<configuration>
<system.codedom>
<compilers>
<!-- For C# -->
<compiler language="c#;cs;csharp" extension=".cs"
compilerOptions="/docpath:C:\Publish\Docs"
type="EWSoftware.CodeDom.CSharpCodeProviderWithDocs,
EWSoftware.CodeDom, Version=1.1.0.0, Culture=neutral,
PublicKeyToken=d633d7d5b41cbb65">
<!-- NOTE: Change value to "v3.5" for .NET 3.5 projects -->
<providerOption name="CompilerVersion" value="v2.0"/>
</compiler>
<!-- For VB.NET -->
<compiler language="vb;vbs;visualbasic;vbscript" extension=".vb"
compilerOptions="/docpath:C:\Publish\Docs"
type="EWSoftware.CodeDom.VBCodeProviderWithDocs,
EWSoftware.CodeDom, Version=1.1.0.0, Culture=neutral,
PublicKeyToken=d633d7d5b41cbb65">
<!-- NOTE: Change value to "v3.5" for .NET 3.5 projects -->
<providerOption name="CompilerVersion" value="v2.0"/>
</compiler>
</compilers>
</system.codedom>
</configuration>
En esta sección indicar donde se van a guardar los
xml generados del proyecto (/docpath). Luego en el SHFB añadir las dll’s necesarias,
la solución/projecto y los xml generados.
Ejemplo. En el caso de querer documentar los servicios de un
webservice se tendría que añadir al SHFB: App_code.xml, App_code.dll y
WService.sln
Posibles problemas detectados: