Comment puis-je obtenir Exemples de code à afficher dans le fichier d'aide en utilisant Sandcastle fichier d'aide Builder?

StackOverflow https://stackoverflow.com/questions/1281843

Question

J'utilise Sandcastle GUI Builder aide du fichier et je ne peux pas sembler obtenir des exemples de code dans mes commentaires apparaissent dans la sortie de fichier d'aide.

Je générer 1.x Aide et documentation HTML style MSDN.

Les exemples ressemblent à ce qui suit dans mon code:

    /// <summary>
    /// Connects to the server
    /// </summary>
    /// <example> Connecting to localhost
    /// <code>
    /// Client client = new Client(true);
    /// EndPoint localhost = new IPEndPoint(IPAddress.Loopback, 8888);
    /// client.Connect(localhost);
    /// </code>
    /// </example>

Dois-je configurer certaines propriétés du projet qui est inconnu pour moi?

Était-ce utile?

La solution

La réponse est que vous n'avez pas besoin de faire quoi que ce soit. Sous Sources de documentation J'ajouté mon .csproj et ce employais les fichiers sous bin/Debug qui ne sont pas en cours de reconstruction. Donc, la réponse pour moi était de changer la documentation Sources aux fichiers sous bin/Release. Stupide, je sais. Je vais laisser cela ici au cas où quelqu'un d'autre a le même problème.

Licencié sous: CC-BY-SA avec attribution
Non affilié à StackOverflow
scroll top