Kysymys:
Mikä työkalu voi luoda HTML-dokumentaatiota C # -koodista, kuten Javadoc voi tehdä Javalle?
Nicolas Raoul
2014-02-05 06:47:08 UTC
view on stackexchange narkive permalink

Java-kehittäjät voivat helposti luoda HTML-dokumentaation Java-koodistaan, mikä on kätevä tapa lähettää sovellusliittymiä verkossa. Tämä on esimerkki.

Onko vastaavaa työkalua C # -koodille?

Sen on oltava ilmainen, mieluiten avoimen lähdekoodin.

On suoritettava ainakin Windowsissa ja Linuxissa.

HTML-kehyksiä ei tarvita, työkalut, jotka tuottavat vain yksi pitkä HTML-sivu on myös täydellinen.

Käytämme [Sandcastle Help File Builderia (SHFB)] (https://github.com/EWSoftware/SHFB). On tehokas ja ilmainen, voit luoda sekä .chm-apua että HTML-tiedostoja.
Neljä vastused:
#1
+16
aman207
2014-02-05 07:10:12 UTC
view on stackexchange narkive permalink

Doxygen näyttää siltä, ​​mikä toimisi sinulle.

  • Se voi luoda online-dokumentointiselaimen (HTML-muodossa) ja / tai pois päältä -viivakäsikirja (muodossa $ \ mbox {\ LaTeX} $) dokumentoitujen lähdetiedostojen joukosta.
  • Tuen tuottamista tuetaan myös RTF (MS-Word), PostScript, hyperlinkitetty PDF, pakattu HTML ja Unix-man-sivuilla.
  • Asiakirjat puretaan suoraan lähteistä, mikä helpottaa dokumentaation pitämistä lähdekoodin mukaisena.

Sitä voidaan käyttää luoda dokumentaatio C #: sta muiden kielten, kuten C, Objective-C, PHP, Java, Python, kanssa.

Olen juuri kokeillut Doxygenia, se toimii kuin viehätys, kiitos paljon!
#2
+16
Lyndon White
2014-02-05 12:29:56 UTC
view on stackexchange narkive permalink

Voit tehdä tämän tavallisella Microsoft C # -kääntäjällä. Vaikka se ei ole avointa lähdekoodia. On kiistatonta, että se on ilmainen, koska se käyttää jo olemassa olevia työkaluja.

C # -tiedostolle XMLsample.cs

  csc XMLsample.cs / doc : XMLsample.xml  

tuottaa xml-tiedoston XMLsample.xml . Soveltamalla tyylisivua tähän sinulla on mukava verkkosivusto. CSS: n pitäisi tehdä, vaikka huomattavampaan uudistamiseen saatat joutua käyttämään XSLT: ää.

katso MSDN


Se on saatavana myös Mono C #: lla kääntäjä. Mono C # on ilmainen ja avoin lähdekoodi.

  mcs XMLsample.cs /doc:XMLsample.xml  

Katso Mustavalkoinen sivu

Tämä ei voi luoda C # -tiedoston dokumentaatiota ilman Main () -metodia. Onko sille muuta komentoa?
@Riky: n kysymykset ohjelmistojen käytöstä sopivat paremmin pääkäyttäjille tai tässä tapauksessa pinoamisvirtaukselle
#3
+5
xpt
2017-02-28 02:54:20 UTC
view on stackexchange narkive permalink

Laitoin 2c: täni, koska seurasin hyväksyttyä vastausta, mutta käy ilmi,

Microsoft C # -kääntäjä tekee vain puolivalmiita töitä. Eli, se antaa sinulle vain xml-tiedoston. Mutta jotta sinulla olisi mukava verkkosivusto, joudut silti käyttämään siihen tyylisivua, ja silta on siinä rikki - Microsoft C # -kääntäjä ei tee sitä, ja Microsoftin tukemat työkalut, Sandcastle CodePlex-projektia ei enää kehitetä aktiivisesti Microsoftin toimesta.

Kaiken kaikkiaan hyväksytty vastaus saattaa olla hyvä vuodelle 2014, mutta ei enää hyvä vuodelle 2017.

Uusi vastaus on Eric Woodruffin Sandcastle Help File Builder sivusto osoitteessa https://GitHub.com/EWSoftware/SHFB, joka on haarautunut ja perustuu nykyiseen Sandcastlen lähdekoodiin.

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

Käytämme Document! X ja se toimii todella hyvin meille. Saat täydelliset API-asiakirjat kommenteista ja sen tyylisivut tekevät siitä näyttävän erittäin hyvältä. He ovat myös reagoivia tukeen.

Tämän sanottuaan se ei ole ilmaista. Mutta mitä se tarjoaa, mielestäni se on sen arvoista. (Aikaisemmin käytimme ilmaista ohjelmaa, ei doxygenia, ja se päätyi liian kalliiksi sen mukaan, kuinka paljon aikaa kului.)



Tämä Q & A käännettiin automaattisesti englanniksi.Alkuperäinen sisältö on saatavilla stackexchange-palvelussa, jota kiitämme cc by-sa 3.0-lisenssistä, jolla sitä jaetaan.
Loading...