Genera file HTML/Guida dalla documentazione XML di VS 2010 C#

Question

Sto cercando un buon strumento per creare file HTML/Guida dalla mia documentazione XML VS2010. Ho trovato alcuni strumenti commerciali, come ad esempio

• .Net documentation tool
• VSDocman

Sono sicuro che ci sono più, ho solo elencare questi due come esempi. Inoltre ci sono semplici fogli di stile XSLT in giro per convertire la documentazione XML in HTML.

Che cosa stai utilizzando, ad es. c'è uno strumento gratuito per fare la conversione, magari come add-in. Giusto per chiarire, in fondo ho trovato due tipi di strumenti:

1. Quelli conversione del file di documentazione XML in diversi formati di destinazione, questo è quello che sto cercando.
2. Strumenti che mi aiutano a generare la documentazione XML nel codice sorgente. Questo non è (!) Quello che sto cercando.

Grazie per il vostro aiuto.

---

La combo Sandcastle/SHFB funziona alla grande. Grazie a tutti coloro che hanno aiutato.

Alcune osservazioni:

1. NDoc sembra essere superata, ultimi aggiornamenti sono a partire dal 2005. È per questo che ho saltato questo.
2. Un thread simile, anche molto dettagliato, può essere trovato qui: How to turn C# Xml Doc-Comments into something useful? Grazie per il suggerimento!
3. ci sono alcune fonti per Castello di sabbia, la versione più recente che ho trovato si trova qui: http://sandcastle.codeplex.com/
4. al fine di generare MsHelp2 ho dovuto installare VS 2008 SDK contenente hscomp.exe. C'è una versione 1.0 e 1.1, per quanto ho potuto capire la versione 1.0 contiene il compilatore. Vedere Helixsoft e Social MSDN per alcuni dettagli.
5. Nel mio caso il WebHelp generato non funziona correttamente con Chrome. Ricarica sempre la pagina index.html.
6. topic here mostra come aggiungere informazioni sullo spazio dei nomi nella documentazione di sandcastle.
7. Aggiornamento a partire da Nov 2012: per i progetti più piccoli sto usando Doxygen - Trovo che sia un po 'più facile da configurare.

Answer 1

Stiamo utilizzando Sandcastle per la trasformazione & Sandcastle Aiuta il File Builder come interfaccia utente per gestire i progetti di aiuto. A mio parere, la bellezza di Sandcastle e SHFB è, oltre alla documentazione "media" del codice sorgente, è possibile aggiungere ulteriori informazioni come l'architettura del programma, i pattern che devono essere seguiti o qualsiasi altro contenuto concettuale per il tuo progetto che non sia legato direttamente in una classe del tuo programma. Questo può essere fatto creando file xml aggiuntivi con l'aiuto dello schema di authoring di Microsoft (può essere modificato con visual studio come file xml e lo schema per esso è disponibile). È piuttosto facile iniziare con questi due strumenti per creare documentazione simile a MSDN.

Molto tempo fa ho provato docbook che è quasi lo stesso sul lato tecnico (file xml contenenti i file di informazione e xslt per trasformarlo in vari tipi di output). Ma non era un'opzione per noi, perché non c'è nessuna trasformazione là fuori che possa usare la documentazione xml generata dallo studio visivo (più la trasformazione del contenuto concettuale è stata piuttosto dolorosa per noi).

Answer 2

più due strumenti gratuiti che permettono la creazione di documentazione da commenti XML:

• NDoc
• Sandcastle

Answer 3

Sandcastle + SHFB sono un grande combo.Gratis e genera html, chm, ecc.