Generare file HTML / aiuto da VS 2010 C documentazione # XML

StackOverflow https://stackoverflow.com/questions/4781784

Domanda

Sto cercando un buon strumento di creazione di file HTML / aiuto dai miei documentazione VS2010 XML. Ho trovato alcuni strumenti commerciali, come ad esempio

Sono sicuro che ci sono più, ho solo elencare questi due come esempi. Inoltre ci sono dei semplici fogli di stile XSLT intorno per convertire il codice XML per documentazione HTML.

Che cosa stai usando, per esempio Esiste uno strumento libero di fare la conversione, forse come componente aggiuntivo. Giusto per chiarire, in fondo ho trovato due tipi di strumenti:

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

Grazie per il vostro aiuto.

Il combo Sandcastle / SHFB grandi opere. Grazie a tutti coloro che hanno contribuito.

Alcune osservazioni:

  1. NDoc sembra essere superata, ultimi aggiornamenti sono a partire dal 2005. È per questo che ho saltato questo.
  2. Un filo simile, anche molto dettagliato, può essere trovato qui: https://stackoverflow.com/questions/3082044/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. Esiste 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. Si ricarica sempre la pagina index.html.
  6. Il tema spettacoli qui come aggiungere informazioni namespace nella documentazione castello di sabbia.
  7. Update come di NOV 2012: per i piccoli progetti Sto usando Doxygen - lo trovo un po 'più facile configurare.
È stato utile?

Soluzione

Stiamo utilizzando Sandcastle Sandcastle per file della Guida Builder per la trasformazione e come interfaccia utente per la gestione dei progetti di aiuto. A mio parere la bellezza del Sandcastle e SHFB è, che accanto alla documentazione del codice sorgente "medio", è possibile aggiungere informazioni aggiuntive come l'architettura del programma, i modelli che devono essere seguite o qualsiasi contenuto concettuale supplementare per il vostro progetto che non è legato direttamente a una classe nel vostro programma. Questo può essere fatto con la creazione di file XML aggiuntivi con l'aiuto di Microsoft Authoring Schema (può essere modificato con Visual Studio, come il file XML e lo schema per esso sono disponibili). La sua piuttosto facile iniziare con quelli entrambi gli strumenti per la creazione di MSDN come la documentazione.

Molto tempo fa ho provato docbook che è quasi la stessa sul lato tecnico (file XML contenente i file di informazione e XSLT per trasformare ai vari tipi di output). Ma non era un'opzione per noi, perché non v'è alcuna trasformazione là fuori che può utilizzare lo studio generato documentazione XML visiva (più la trasformazione del contenuto concettuale è stato abbastanza doloroso per noi).

Altri suggerimenti

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

Sandcastle + SHFB sono un ottimo combo. Libero e genera HTML, CHM, ecc

Autorizzato sotto: CC-BY-SA insieme a attribuzione
Non affiliato a StackOverflow
scroll top