Vraag:
Welke tool kan HTML-documentatie genereren op basis van C # -code, zoals Javadoc kan doen voor Java?
Nicolas Raoul
2014-02-05 06:47:08 UTC
view on stackexchange narkive permalink

Java-ontwikkelaars kunnen eenvoudig HTML-documentatie genereren op basis van hun Java-code, wat een handige manier is om API's online te plaatsen. Dit is een voorbeeld.

Is er een vergelijkbare tool voor C # -code?

Het moet gratis zijn, idealiter open source.

Moet in ieder geval op Windows en Linux draaien.

HTML-frames zijn niet nodig, tools die alleen één lange HTML-pagina is ook perfect.

We gebruiken [Sandcastle Help File Builder (SHFB)] (https://github.com/EWSoftware/SHFB). Is krachtig en gratis, u kunt zowel .chm-help als ook html genereren.
Vier antwoorden:
#1
+16
aman207
2014-02-05 07:10:12 UTC
view on stackexchange narkive permalink

Doxygen lijkt wat voor u zou werken.

  • Het kan een online documentatiebrowser (in HTML) en / of een uit -line referentiehandleiding (in $ \ mbox {\ LaTeX} $) uit een set gedocumenteerde bronbestanden.
  • Er is ook ondersteuning voor het genereren van uitvoer in RTF (MS-Word), PostScript, hyperlink-PDF, gecomprimeerde HTML en Unix-manpagina's.
  • De documentatie wordt rechtstreeks uit de bronnen gehaald, wat het veel gemakkelijker maakt om de documentatie consistent te houden met de broncode.

Het kan worden gebruikt om documentatie te genereren vanuit C #, samen met andere talen zoals C, Objective-C, PHP, Java, Python.

Ik heb zojuist Doxygen geprobeerd, het werkt als een charme, heel erg bedankt!
#2
+16
Lyndon White
2014-02-05 12:29:56 UTC
view on stackexchange narkive permalink

U kunt dit doen met de normale Microsoft C # -compiler. Hoewel het geen open source is. Het is duidelijk gratis, omdat het tools gebruikt die je al hebt.

Voor C # -bestand met de naam XMLsample.cs

  csc XMLsample.cs / doc : XMLsample.xml  

produceert xml-bestand XMLsample.xml . Door hier een stylesheet op toe te passen, heb je een mooie website. CSS zou voldoende moeten zijn, maar voor meer significante herformattering moet u wellicht XSLT gebruiken.

zie MSDN


Het is ook beschikbaar op de Mono C # compiler. Mono C # is gratis en open source.

  mcs XMLsample.cs /doc:XMLsample.xml  

Zie Mono manpage

Dit kan de documentatie van een C # -bestand zonder Main () - methode niet genereren. Is er een ander commando voor?
@Riky-vragen over het gebruik van software zijn beter geschikt voor superuser, of in dit geval stackoverflow
#3
+5
xpt
2017-02-28 02:54:20 UTC
view on stackexchange narkive permalink

Mijn 2c invoeren omdat ik het geaccepteerde antwoord volgde, maar het blijkt,

Microsoft C # -compiler doet slechts een halfbakken klus. Dat wil zeggen, het geeft je alleen een xml-bestand. Maar om een ​​mooie website te hebben, moet je er nog een stylesheet op toepassen, en dat is waar de brug is verbroken - Microsoft C # -compiler doet dat niet, en de door Microsoft ondersteunde tools die dat doen, de Sandcastle CodePlex-project, wordt niet langer actief ontwikkeld door Microsoft.

Al met al is het geaccepteerde antwoord misschien goed voor het jaar 2014, maar niet langer goed voor 2017.

Het nieuwe antwoord is Eric Woodruff's Sandcastle Help File Builder site op https://GitHub.com/EWSoftware/SHFB, die is geforked en gebaseerd op de bestaande Sandcastle-broncode.

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

We gebruiken Document! X en het werkt heel goed voor ons. U krijgt de volledige API-documenten uit de opmerkingen en de stijlbladen ervoor zorgen ervoor dat het er heel erg mooi uitziet. Ze reageren ook erg op ondersteuning.

Dat gezegd hebbende, het is niet gratis. Maar voor wat het oplevert, denk ik dat het het zeker waard is. (We gebruikten voorheen een gratis programma, geen doxygen, en dat werd uiteindelijk te duur in termen van hoeveel tijd het kostte.)



Deze Q&A is automatisch vertaald vanuit de Engelse taal.De originele inhoud is beschikbaar op stackexchange, waarvoor we bedanken voor de cc by-sa 3.0-licentie waaronder het wordt gedistribueerd.
Loading...