Frage:
Welches Tool kann HTML-Dokumentation aus C # -Code generieren, wie es Javadoc für Java tun kann?
Nicolas Raoul
2014-02-05 06:47:08 UTC
view on stackexchange narkive permalink

Java-Entwickler können auf einfache Weise HTML-Dokumentation aus ihrem Java-Code generieren. Dies ist eine bequeme Möglichkeit, APIs online zu veröffentlichen. Dies ist ein Beispiel.

Gibt es ein ähnliches Tool für C # -Code?

Es muss kostenlos sein, idealerweise Open Source.

Muss mindestens unter Windows und Linux ausgeführt werden.

HTML-Frames werden nicht benötigt, Tools, die nur generieren Eine lange HTML-Seite ist auch perfekt.

Wir verwenden [Sandcastle Help File Builder (SHFB)] (https://github.com/EWSoftware/SHFB). Ist leistungsstark und kostenlos, können Sie sowohl .chm-Hilfe als auch HTML generieren.
Vier antworten:
#1
+16
aman207
2014-02-05 07:10:12 UTC
view on stackexchange narkive permalink

Doxygen scheint das zu sein, was für Sie funktionieren würde.

  • Es kann einen Online-Dokumentationsbrowser (in HTML) und / oder einen Off generieren -Linienreferenzhandbuch (in $ \ mbox {\ LaTeX} $) aus einer Reihe dokumentierter Quelldateien.
  • Es wird auch die Generierung von Ausgaben in RTF- (MS-Word), PostScript-, Hyperlink-PDF-, komprimierten HTML- und Unix-Manpages unterstützt.
  • Die Dokumentation wird direkt aus den Quellen extrahiert, wodurch es viel einfacher ist, die Dokumentation mit dem Quellcode konsistent zu halten.
/ blockquote>

Sie kann verwendet werden um Dokumentation aus C # zusammen mit anderen Sprachen wie C, Objective-C, PHP, Java, Python zu generieren.

Ich habe gerade Doxygen ausprobiert, es funktioniert wie ein Zauber, vielen Dank!
#2
+16
Lyndon White
2014-02-05 12:29:56 UTC
view on stackexchange narkive permalink

Sie können dies mit dem normalen Microsoft C # -Compiler tun. Obwohl es nicht Open Source ist. Debatt ist kostenlos, da es Tools verwendet, die Sie bereits haben.

Für C # -Dateien mit dem Namen XMLsample.cs

  csc XMLsample.cs / doc : XMLsample.xml  

erzeugt die XML-Datei XMLsample.xml . Wenn Sie ein Stylesheet darauf anwenden, erhalten Sie eine schöne Website. CSS sollte funktionieren, für eine umfassendere Reformierung müssen Sie möglicherweise XSLT verwenden.

siehe MSDN


Es ist auch auf dem Mono C # verfügbar. Compiler. Mono C # ist kostenlos und Open Source.

  mcs XMLsample.cs /doc:XMLsample.xml  

Siehe Mono-Manpage

Dies kann die Dokumentation einer C # -Datei ohne Main () -Methode nicht generieren. Gibt es einen anderen Befehl dafür?
@Riky-Fragen zur Verwendung von Software eignen sich besser für Superuser oder in diesem Fall für Stackoverflow
#3
+5
xpt
2017-02-28 02:54:20 UTC
view on stackexchange narkive permalink

Ich habe mein 2c eingegeben, weil ich der akzeptierten Antwort gefolgt bin, aber es stellt sich heraus, dass der

Microsoft C # -Compiler nur einen halbherzigen Job macht. Das heißt, es gibt Ihnen nur eine XML-Datei. Aber um eine schöne Website zu haben, müssen Sie noch ein Stylesheet darauf anwenden, und hier ist die Brücke gebrochen - der Microsoft C # -Compiler macht das nicht und die von Microsoft unterstützten Tools, die das tun, Sandcastle Das CodePlex-Projekt wird von Microsoft nicht mehr aktiv entwickelt.

Alles in allem ist die akzeptierte Antwort vielleicht gut für das Jahr 2014, aber nicht mehr gut für 2017.

Die neue Antwort ist Eric Woodruffs Sandcastle Help File Builder Website unter https://GitHub.com/EWSoftware/SHFB, die gegabelt ist und auf dem vorhandenen Sandcastle-Quellcode basiert.

#4
+2
David Thielen
2014-07-30 19:51:36 UTC
view on stackexchange narkive permalink

Wir verwenden Dokument! X und es funktioniert wirklich gut für uns. Sie erhalten die vollständigen API-Dokumente aus den Kommentaren und den Stylesheets dafür, dass es sehr, sehr schön aussieht. Sie reagieren auch sehr schnell auf Support.

Trotzdem ist es nicht kostenlos. Aber für das, was es liefert, denke ich, dass es sich lohnt. (Wir haben zuvor ein kostenloses Programm verwendet, nicht Sauerstoff, und das war zu teuer, was die Zeit angeht.)



Diese Fragen und Antworten wurden automatisch aus der englischen Sprache übersetzt.Der ursprüngliche Inhalt ist auf stackexchange verfügbar. Wir danken ihm für die cc by-sa 3.0-Lizenz, unter der er vertrieben wird.
Loading...