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?
7
A
risposta
13
Sì, c'è - la biblioteca deve essere costruita con il "file XML Documentazione" tickbox controllata (nelle pagine di proprietà del progetto)
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).
Si dovrebbe distribuire questo file fianco (nella stessa directory) la libreria compilata.
Problemi correlati
- 1. Come localizzare la documentazione di una libreria .NET
- 2. XSD per la documentazione XML generata per C#?
- 3. Esiste una documentazione XML di Android?
- 4. Come si ottiene MSBuild Task per generare documenti XML quando si crea una soluzione?
- 5. Come si fa la documentazione nell'obiettivo C?
- 6. Documentazione del codice di libreria C++/CLI per l'uso da C# - i migliori strumenti e pratiche?
- 7. Documentazione API per la libreria yaml-cpp
- 8. Come si fa riferimento a una libreria di classi C# da un'applicazione metropolitana Javascript Win8?
- 9. C#: come si ottiene una classe base di classe?
- 10. Come si ottiene geom_map per mostrare tutte le parti di una mappa?
- 11. Come analizzare una stringa XML anziché XML doc in c utilizzando la libreria libxml2
- 12. Come si ottiene la paykey da un transactionId?
- 13. Come ignorare una classe durante la generazione di documentazione XML per un progetto di Visual Studio?
- 14. Documentazione simile a Javadoc per i commenti XML di C#
- 15. Quando si utilizza un progetto di libreria Android come si fa riferimento alle risorse xml correttamente?
- 16. Come si ottiene un lungo senza segno da una stringa?
- 17. Come si ottiene IIS per caricare una DLL nativa a cui fa riferimento il servizio WCF?
- 18. Come si ottiene il valore di una proprietà da PropertyInfo?
- 19. Documentazione di riferimento per il rasoio ASP.NET
- 20. Come utilizzare una libreria C++ da C# e .NET?
- 21. Come fornite commenti/documentazione xml per i parametri dei delegati?
- 22. Come si ottiene una descrizione dell'errore di std :: exception quando si chiama una dll C++ da C#
- 23. Documentazione XML per le proprietà di dipendenza
- 24. Come convincere Eclipse a mostrare la documentazione di javadoc su Ubuntu 9.04 per openjdk?
- 25. Compilare usando MONO - C# con riferimento a una libreria C#?
- 26. Chiama libreria C++ da C#
- 27. Come usare una libreria C da D?
- 28. ImportError da Cython quando si collega una libreria C esterna
- 29. Attributi e documentazione XML per metodo/proprietà
- 30. Documentazione di riferimento Qt5: file qch