Java-Entwickler können auf einfache Weise HTML-Dokumentation aus ihrem Java-Code generieren, was eine praktische Möglichkeit darstellt, APIs online zu stellen. 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 laufen.
HTML-Frames werden nicht benötigt, Tools, die nur eine lange HTML-Seite generieren, sind ebenfalls perfekt.
Sie können dies mit dem normalen Microsoft C#-Compiler tun. Obwohl es nicht Open Source ist. Zweifellos ist es kostenlos, da es Tools verwendet, die Sie bereits haben.
Für C#-Datei aufgerufenXMLsample.cs
csc XMLsample.cs /doc:XMLsample.xml
erzeugt eine XML-Datei XMLsample.xml. Indem Sie ein Stylesheet darauf anwenden, haben Sie eine schöne Website. CSS sollte ausreichen, obwohl Sie für eine signifikantere Neuformatierung möglicherweise XSLT verwenden müssen.
Es ist auch auf dem Mono C#-Compiler verfügbar. Mono C# ist kostenlos und Open Source.
mcs XMLsample.cs /doc:XMLsample.xml
Doxygen scheint das zu sein, was für Sie funktionieren würde.
- Es kann einen Online-Dokumentationsbrowser (in HTML) und/oder ein Offline-Referenzhandbuch (in $\mbox{\LaTeX}$) aus einer Reihe von dokumentierten Quelldateien generieren.
- Es gibt auch Unterstützung für die Generierung von Ausgaben in RTF (MS-Word), PostScript, Hyperlink-PDF, komprimiertem HTML und Unix-Manpages.
- Die Dokumentation wird direkt aus den Quellen extrahiert, was es viel einfacher macht, die Dokumentation konsistent mit dem Quellcode zu halten.
Es kann verwendet werden, um Dokumentation aus C# zusammen mit anderen Sprachen wie C, Objective-C, PHP, Java, Python zu generieren.
Setzen Sie meine 2c ein, weil ich der akzeptierten Antwort gefolgt bin, aber es stellt sich heraus,
Der Microsoft C#-Compiler macht nur einen halbgaren Job. Das heißt, es gibt Ihnen nur eine xml-Datei. Aber um eine schöne Website zu haben, müssen Sie immer noch ein Stylesheet darauf anwenden, und hier ist die Brücke gebrochen – der Microsoft C#-Compiler tut das nicht, und die von Microsoft unterstützten Tools, die das tun, das Sandcastle CodePlex-Projekt wird von Microsoft nicht mehr aktiv weiterentwickelt.
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 - Site unter https://GitHub.com/EWSoftware/SHFB , die geforkt ist und auf dem vorhandenen Sandcastle-Quellcode basiert.
Wir verwenden Dokument! X und es funktioniert wirklich gut für uns. Sie erhalten die vollständigen API-Dokumente aus den Kommentaren und die Stylesheets dafür lassen es sehr, sehr gut aussehen. Sie reagieren auch sehr schnell auf den Support.
Wie gesagt, es ist nicht kostenlos. Aber für das, was es liefert, denke ich, dass es sich lohnt. (Wir haben zuvor ein kostenloses Programm verwendet, nicht Doxygen, und das war letztendlich zu teuer in Bezug auf den Zeitaufwand.)
Christi Ursachi