Come posso esportare la documentazione del codice in C#/VisualStudio 2008?

Question

Ho sempre ritenuto importante scrivere commenti di codice piacevoli per classi e metodi con la sintassi C# xml.Mi sono sempre aspettato di poterli esportare facilmente in seguito.

Oggi in realtà devo farlo, ma ho difficoltà a scoprire come.C'è qualcosa che mi sfugge?Voglio andare Menu->Crea->Crea documentazione del codice, ma non c'è alcuna opzione per farlo, lì.

Answer 1

In realtà è nelle proprietà del progetto.Scheda Crea, sezione Output, file di documentazione XML e inserisci il nome del file.Sarà costruito su ogni build del progetto.

Dopodiché puoi creare l'aiuto vero e proprio Castello di sabbia.

Answer 2

Potresti provare NDOC O Castello di sabbia se non ti dispiace usare strumenti di terze parti.

Answer 3

Castello di sabbia funziona abbastanza bene per generare documentazione e supporta un paio di formati diversi per la generazione.Per quanto ne so, non esiste alcuna integrazione con Visual Studio, ma esiste un file GUI del castello di sabbia per quello che è disponibile.

Answer 4

Fai attenzione se utilizzi LINQ to SQL poiché non sarai in grado di aggiungere facilmente commenti sostenibili agli oggetti generati automaticamente.

Answer 5

Commento tardivo, ma vale la pena aggiungere che anche se Sandcastle è messo fuori servizio, il Generatore di file di aiuto di Sandcastle rimane in fase di sviluppo attivo e l'ho trovato molto potente e semplice da approfondire quando si affronta proprio questa situazione: installa su un ricco output .chm e .html/.asp in un paio d'ore.

Answer 6

Il progetto NDoc originale (menzionato da altri) è morto, ma esiste un nuovo progetto chiamato NDoc3.

NDoc3 supporta .NET 2.0 - 3.5.Attualmente è disponibile in versione beta e per me ha funzionato benissimo.Non sono sicuro che il progetto sia ancora attivo: l'ultima beta è stata rilasciata nell'aprile 2009.