Domanda:
Quale strumento può generare documentazione HTML da codice C #, come Javadoc può fare per Java?
Nicolas Raoul
2014-02-05 06:47:08 UTC
view on stackexchange narkive permalink

Gli sviluppatori Java possono generare facilmente documentazione HTML dal loro codice Java, che è un modo conveniente per pubblicare le API online. Questo è un esempio.

Esiste uno strumento simile per il codice C #?

Deve essere gratuito, idealmente open source.

Deve essere eseguito almeno su Windows e Linux.

Non sono necessari frame HTML, strumenti che generano solo anche una lunga pagina HTML è perfetta.

Usiamo [Sandcastle Help File Builder (SHFB)] (https://github.com/EWSoftware/SHFB). È potente e gratuito, puoi generare sia la guida .chm che anche html.
Quattro risposte:
#1
+16
aman207
2014-02-05 07:10:12 UTC
view on stackexchange narkive permalink

Doxygen sembra quello che potrebbe funzionare per te.

  • Può generare un browser di documentazione in linea (in HTML) e / o un -line manuale di riferimento (in $ \ mbox {\ LaTeX} $) da un insieme di file sorgente documentati.
  • Esiste anche il supporto per la generazione di output in RTF (MS-Word), PostScript, PDF con collegamenti ipertestuali, HTML compresso e pagine man Unix.
  • La documentazione viene estratta direttamente dai sorgenti, il che rende molto più facile mantenere la documentazione coerente con il codice sorgente.

Può essere utilizzato per generare documentazione da C #, insieme ad altri linguaggi come C, Objective-C, PHP, Java, Python.

Ho appena provato Doxygen, funziona a meraviglia, grazie mille!
#2
+16
Lyndon White
2014-02-05 12:29:56 UTC
view on stackexchange narkive permalink

Puoi farlo con il normale compilatore Microsoft C #. Sebbene non sia open source. Debolmente è gratuito, poiché utilizza strumenti che già possiedi.

Per file C # chiamato XMLsample.cs

  csc XMLsample.cs / doc : XMLsample.xml  

produrrà il file xml XMLsample.xml . Applicando un foglio di stile a questo, avrai un bel sito web. CSS dovrebbe andare bene, anche se per una riformattazione più significativa potrebbe essere necessario utilizzare XSLT.

vedi MSDN


È anche disponibile su Mono C # compilatore. Mono C # è gratuito e open source.

  mcs XMLsample.cs /doc:XMLsample.xml  

Vedi Manpage Mono

Questo non può generare la documentazione di un file C # senza il metodo Main (). C'è qualche altro comando per questo?
-1
#3
+5
xpt
2017-02-28 02:54:20 UTC
view on stackexchange narkive permalink

Inserendo il mio 2c perché stavo seguendo la risposta accettata, ma si scopre che

Il compilatore Microsoft C # sta facendo solo un lavoro a metà. Cioè, ti dà solo un file xml. Ma per avere un bel sito web, dovrai comunque applicare un foglio di stile ad esso, ed è qui che il ponte è rotto: il compilatore Microsoft C # non lo fa e gli strumenti supportati da Microsoft che lo fanno, il Sandcastle Il progetto CodePlex, non è più in fase di sviluppo attivo da parte di Microsoft.

Tutto sommato, la risposta accettata potrebbe essere valida per l'anno 2014, ma non più valida per il 2017.

La nuova risposta è Sandcastle Help File Builder strong di Eric Woodruff > sito su https://GitHub.com/EWSoftware/SHFB, che è biforcuto e basato sul codice sorgente Sandcastle esistente.

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

Usiamo Document! X e funziona davvero bene per noi. Ottieni i documenti API completi dai commenti e dai fogli di stile per farlo sembrare molto molto bello. Sono anche molto reattivi all'assistenza.

Detto questo, non è gratuito. Ma per quello che offre, penso che ne valga la pena. (In precedenza abbiamo utilizzato un programma gratuito, non doxygen, e questo è risultato troppo costoso in termini di tempo impiegato.)



Questa domanda e risposta è stata tradotta automaticamente dalla lingua inglese. Il contenuto originale è disponibile su stackexchange, che ringraziamo per la licenza cc by-sa 3.0 con cui è distribuito.
Loading...