2010-05-15 1 views
8

Gibt es eine Möglichkeit, aus der Dokumentation des Codes direkt aus Visual Studio eine lesbare Dokumentdatei zu generieren? (Auch unter Berücksichtigung 2010)Wie generiert man C# -Dokumentation zu einer CHM- oder HTML-Datei?

Code-Beispiel:

/// <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(); 
} 

Antwort

4

VSdocman kann es von Visual Studio direkt tun.

+1

Tolles Werkzeug! Arbeitet bereits mit Visual Studio 2010, ist sehr einfach zu bedienen und erzeugt großartige Dokumentationen. – BrunoLM

9

Verwendung DocProject. Es kann HTML-Dokumente sowie CHM erstellen. Sie sollten zuerst Sandcastle installieren.

+0

+1 für mich, um es zu schlagen :) –

+0

Es ist nicht auf meinem Windows 7 x64 funktioniert. DocProject stürzt nur die ganze Zeit – BrunoLM

+0

Ist es in VS2010 möglich? – Saint

4

Check out doxygen

+0

+1 für Doxygen nach dem Kampf mit Sandburg. IMO Einfacher zu bedienen und schöner aussehende Ergebnisse – user430788

2

Sandcastle Help File builder ist ein weiterer

+0

Das ist das Beste. Hat am Ende des Jahres Support für VS2010, VS2012, VS2013 und wahrscheinlich auch VS2014. Sie können in MS Word, HTML, CHM und andere Hilfeformate exportieren. –

Verwandte Themen