2010-11-17 12 views
7

Supponiamo di disporre di una libreria C# con diverse funzioni, tutte documentate con il solito /// <summary> compilato correttamente. Fare riferimento al progetto farà apparire la funzione e la descrizione dei parametri nella guida contestuale di Visual Studio. Ma è possibile avere questo spettacolo se non si fa riferimento al progetto stesso, solo una build (e potenzialmente qualche altro file che contiene la documentazione)?Come si ottiene la documentazione XML da mostrare per una libreria C# di riferimento?

risposta

13

Sì, c'è - la biblioteca deve essere costruita con il "file XML Documentazione" tickbox controllata (nelle pagine di proprietà del progetto)

alt text

Con questa opzione spuntata il processo di costruzione sarà ora costruire un file XML aggiuntivo nella directory di output che contiene tutta la documentazione xml - ogni volta che Visual Studio fa riferimento a un assembly per file, caricherà e mostrerà la documentazione intellisense da questo file XML (se può essere trovato).

alt text

Si dovrebbe distribuire questo file fianco (nella stessa directory) la libreria compilata.

Problemi correlati