Esiste una buona guida rapida per la generazione di documenti API con Sandcastle?

Question

Genererò i documenti API usando Sandcastle - Non ho trovato nessuna guida su come farlo sul sito web. Qualcuno ha delle guide di avvio rapido che raccomanderebbero?

Answer 1

Suggerirei di utilizzare SHFB (se puoi), in quanto lo rende davvero più semplice. SHFB viene fornito con la documentazione, ma sarai in grado di utilizzare le sue funzionalità comuni senza alcun tutorial.

Answer 2

Sono anche un forte supporto di SHFB , tant'è che a settembre 2010 ho scritto un articolo considerevole su Sandcastle e SHFB intitolato Taming Sandcastle: una guida per programmatori .NET alla documentazione del codice in cui descrivo i suggerimenti per l'uso e molte delle potenziali insidie ??che si possono incontrare. Nell'ottobre 2010 l'ho seguito con un grafico a parete di una pagina che sintetizza il lessico dei commenti della documentazione XML per SHFB.

Dalla mia ricerca per l'articolo, ecco un elenco completo di altre risorse utili:

• Documentazione sul costruttore di file di aiuto di Sandcastle (SHFB Creator)
• Guida per programmatori C #: Tag consigliati per i commenti sulla documentazione (MSDN)
• Wm. Guida ai commenti sulla documentazione XML di Eric Brunsen (Dynicity)
• Documentazione XML di Anson Horton in C # (Microsoft C # Compiler Program Manager)

Answer 3

Forse potresti controllare il sito (codeplex) di SandCastle . Ma la mia esperienza è che è meglio solo giocarci. La prima cosa che devi fare è configurare la tua applicazione per generare i tuoi commenti in un file XML (e usare i commenti XML nel tuo codice). Questa è un'impostazione nel tuo progetto.

La prossima cosa che puoi fare è caricare il tuo assembly con l'XML associato in Sandcastle e giocare con le impostazioni (nella maggior parte dei casi le impostazioni predefinite sono abbastanza buone). La maggior parte delle impostazioni sono auto-documentate o sono evidenti guardando il nome.

Buona fortuna a giocarci!