Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How do I create an XML Intellisense file for my DLL?

Tags:

I am creating a DLL in C#, using VS 2010, and I have created XML comments for all of its members. When I build the DLL, how do I generate the XML file that will provide Intellisense for the DLL? Thanks for your help.

like image 436
David Veeneman Avatar asked Feb 04 '11 01:02

David Veeneman


People also ask

How to generate XML documentation in C#?

To generate an XML documentation file from documentation comments in the code, use the /doc option with the csc.exe C# compiler. When you build the project, an XML file will be produced by the compiler with a name corresponding to the project name (e.g. XMLDocumentation. dll -> XMLDocumentation.

How do I add an XML file to Visual Studio?

In Visual Studio, open the File menu and select New > File. Or, use the Ctrl+N keyboard shortcut. In the New File dialog box, select XML Schema and then select Open. A new file is created.

What is the proper commenting method for XML?

To insert XML comments for a code element Type /// in C#, or ''' in Visual Basic.

How do I make comments in Visual Studio?

The only way I know to do this is on the line right above your method just type "///" and it will generate a comment template based on the method.


1 Answers

In the project properties page, go to the Build tab. In the Output section near the bottom there's a check-box labelled "XML documentation file" that needs to be checked.

like image 113
Andrew Cooper Avatar answered Sep 18 '22 12:09

Andrew Cooper