Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Adding Comments to Parameter in DLL

Tags:

c#

.net

xml

I had created a DLL in .NET ,which includes several function.Now I am suing this DLL in another App enter image description here

I want that whenever the client uses my DLL,somesort of comments must be shown that shows return type,Parameters etc.like this enter image description here

i see people this using XML files.Is there any alternative way? Thanks in meekness

like image 714
require_once Avatar asked Jun 25 '12 16:06

require_once


1 Answers

You need to use XML documentation specified in comments before the member declaration.

/// <summary>Some stuff here</summary>
/// <remarks>Some remarks</remarks>
/// <param name="foo">The foo to gronk</param>

Then go into your project properties and enable building an XML file alongside your library in the "Build" tab. Distribute that along with your DLL, and Visual Studio will display your content.

like image 56
Jon Skeet Avatar answered Oct 24 '22 18:10

Jon Skeet