.Net XML commento nella Documentazione delle API

Question

C'è un modo semplice per produrre MSDN stile documentazione di Visual Studio XML di output?
Io non sono paziente sufficiente per impostare un buon xslt per questo, perché so di non essere la prima persona ad attraversare il ponte.

Inoltre, ho provato a installare sandcastle di recente, ma che ha reso i miei occhi croce.O mi manca qualcosa di importante nel processo o è solo modo troppo coinvolto.

So che qualcuno là fuori ha davvero un bel morti-soluzione semplice.

Sto ribadendo qui perché penso che il mio formattazione fatto che il punto di non invitare a leggere:

Ho dato castelli di sabbia e di una prova, ma ha avuto un momento davvero difficile ottenere da esso istituito.Quello che ho in mente è qualcosa di molto più semplice.

Che è, a meno che non riesco a capire il processo di castelli di sabbia.Sembrava un sacco di extra bagaglio a me solo per produrre qualcosa di bello per il tester per lavorare con.

Answer 1

Stai cercando castelli di sabbia

Pagina Del Progetto: Sandcastle Versioni

Blog: Sandcastle Blog

NDoc Codice Generatore di Documentazione per .NET usato per essere lo strumento di scelta, ma il supporto è di tutti, ma si fermò.

Answer 2

Guarda Sandcastle, che fa esattamente questo.È anche uno dei più semplici soluzioni là fuori, ed è più o meno lo strumento di scelta, così a lungo, forse potremmo aiutarti a impostare Sandcastle se si specificare quali sono i problemi che si riscontrano durante l'installazione?

Answer 3

Si dovrebbe anche usare il Sandcastle File di Aiuto Builder.Esso fornisce un ndoc come GUI per la generazione di file di aiuto, quindi non devi fare nulla da un prompt dei comandi.

Benvenuti a Sandcastle File di Aiuto Generatore di Progetto

Answer 4

Seguire questo semplice passo 5 articolo e si è praticamente fatto.Come bonus, è possibile utilizzare H2Viewer per visualizzare la Guida Html 2.x files.

Answer 5

Ho appena impostato castelli di sabbia di nuovo.Provare a ripetere l'installazione (Maggio 2008) e la ricerca di SandcastleGui.exe o qualcosa di simile (è nella cartella esempi o giù di lì).

Fare clic su Aggiungi Assemblea e aggiungere la vostra o più Assembly, aggiungere qualsiasi .file di Documentazione xml (quelli generati dal compilatore se è attivata l'opzione) e poi Costruire.

Ci vorrà del tempo, ma il risultato sarà essere valsa la pena.Effettivamente cercare roba da MSDN, in modo che la vostra documentazione risultante avrà anche l'Ereditarietà di Classe tutto il senso giù al Sistema.Oggetto con collegamenti a MSDN e roba del genere.

Sandcastle sembra un po ' complicato all'inizio, soprattutto quando si desidera utilizzare in un sistema automatizzato di costruire, ma sono assolutamente sicuro che sarà valsa la pena.

Anche un'occhiata a Sandcastle File Di Aiuto Builder, questo è un po ' più avanzata interfaccia grafica per farlo.

Answer 6

Io uso NDoc3