9
votes

Comment générer C # documentation dans un fichier CHM ou HTML?

Y a-t-il un moyen de générer un fichier de document lisible à partir de la documentation du code directement à partir de Visual Studio? (Considérant également 2010)

Exemple de code: P>

/// <summary>
/// Convert a number to string
/// </summary>
/// <param name="number">An integer number to be converted to string</param>
/// <returns>Number as string</returns>
/// <example>
/// <code>
///     var s = MyMethod(5);
/// </code>
/// </example>
/// <exception cref="Exception">In case it can't convert</exception>
/// <remarks>
/// Whatever
/// </remarks>
public string MyMethod(int number)
{
    return number.ToString();
}


0 commentaires

4 Réponses :


9
votes

Utilisez DocProject . Il peut créer des documents HTML aussi bien chm. Vous devriez installer Sandcastle d'abord.


2 commentaires

Cela ne fonctionne pas sur ma fenêtre 7 x64. DocProject vient de planter tout le temps


Sandcastle Travail parfait avec moi, j'ai utilisé l'outil "Sandcastlegui.exe", merci !.



4
votes

Vous pouvez regarder DOXYGEN


1 commentaires

+1 pour Doxygen après avoir combattu avec Sandcastle. OMI plus facile à utiliser et de résultats plus agréables



4
votes

VSDocman peut le faire directement à partir de Visual Studio.


1 commentaires

Super outil! Travaille déjà avec Visual Studio 2010, très simple à utiliser et générer de superbes documentaires.



2
votes

1 commentaires

C'est le meilleur. A la prise en charge de VS2010, VS2012, VS2013 et probablement également VS2014 à la fin de l'année. Vous pouvez exporter vers MS Word, HTML, CHM et d'autres formats d'aide.