Sandcastle

De Banane Atomic
Aller à la navigationAller à la recherche

Description

Génération d'une documentation style MSDN à partir d'assemblies .NET et des fichiers de commentaires XML associés.

Formats de sortie Extensions
HTML Help 1 CHM
Microsoft Help Viewer MSHC
Websites HTML
Markdown MD. There are some known issues and limitations with this format.
Open XML DOCX

Installation

  1. Télécharger et installer Sandcastle

Utilisation

Sandcastle Help File Builder GUI

Project Properties

Build

  • Framework Version
  • Help File Format → HTML Help 1 (chm), Website (HTML)
  • KeepLogFile → False, supprimer le log si la compilation a réussi

Help File

  • PresentationStyle → VS2013

Visibility

  • DocumentInheritedFramework... → false, n'ajoute pas la documentation du Framework .NET

Missing Tags

  • ShowMissingNamespaces → false

Paths

  • OutputPath

Utilisation en ligne de commande

Dos.svg
%SystemRoot%\Microsoft.NET\Framework\v3.5\MSBuild.exe projet.shfbproj

Les "SandcastleProject Properties" définie dans le fichier shfbproj sont utilisée pour la génération, mais il est possible de les redéfinir, ex:

/p:PresentationStyle=hana

Erreurs

SHFB: Error BE0065: BUILD FAILED: The 'p' start tag on line 1241 position 2 does not match the end tag of 'th'. Line 1241, position 92.

L'assembly System.ValueTuple pose problème.

Unresolved assembly reference: Newtonsoft.Json

Plug-Ins → Assembly Binding Redirection → Configure → Onglet Ignore If Unresolved → Add Newtonsoft.Json

Could not load file or assembly Microsoft.Build, Version=14.0.0.0

Installer Microsoft Build Tools 2015

The project does not have any documentation sources defined

Ajouter des éléments dans Documentation Sources.

No APIs found to document