How to include documentation into assmblies?
-
Hi! I have produced a class library with documentation (
<summary>,<param >...) of any type and member. But after compiling it, my documentation is lost. How can I include my documentation into my comiled assembly, so that it appears in IntelliSense and Object Browser?? -
Hi! I have produced a class library with documentation (
<summary>,<param >...) of any type and member. But after compiling it, my documentation is lost. How can I include my documentation into my comiled assembly, so that it appears in IntelliSense and Object Browser??You can define a path for the assemblyname.xml file in your project's properties. If this XML documentation has the same name as the DLL, IntelliSense will find it in the folder that contains the assembly and display the summaries.
-
Hi! I have produced a class library with documentation (
<summary>,<param >...) of any type and member. But after compiling it, my documentation is lost. How can I include my documentation into my comiled assembly, so that it appears in IntelliSense and Object Browser??Go into your Project Properties, Configuration Properties, Build, and make sure that XML Documentation File is set to the same filename with an XML extension as your assembly. For instance, if your target filename is myAssm.DLL, then your XML Doc filename should be myAssm.DLL.XML. RageInTheMachine9532
-
Go into your Project Properties, Configuration Properties, Build, and make sure that XML Documentation File is set to the same filename with an XML extension as your assembly. For instance, if your target filename is myAssm.DLL, then your XML Doc filename should be myAssm.DLL.XML. RageInTheMachine9532
Actually, just myAssm.xml is fine. This is how the FCL XML documentation is named as well.
Microsoft MVP, Visual C# My Articles