Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

see the dll comments in c#

Tags:

comments

c#

I have written the c# comments of my function,and then i gave the dll file to my friends who need it,but when he use those functions ,he can't see the comments,how to solve this problem?
Ps: I can see the comments when i use it in my project;

like image 477
magicshui Avatar asked Oct 05 '10 12:10

magicshui


People also ask

How can I see the details of a DLL?

To view DLL propertiesSelect the desired DLL and right-click the file. Click Properties and Version.

Can you see source code of DLL?

You cannot see the source of a dll file, it contains object code only. There are tools that can try to reverse engineer it for you but they will not give you the exact original source.

How do I open DLL files to edit?

In the File Explorer window, go to the folder location of the DLL file that you want to edit. Select the DLL. Click once the DLL to do so. Click Open.

What is DLL file in C#?

A DLL is a library that contains code and data that can be used by more than one program at the same time. For example, in Windows operating systems, the Comdlg32 DLL performs common dialog box related functions. Each program can use the functionality that is contained in this DLL to implement an Open dialog box.


2 Answers

Comments are ripped off the assembly, you'll have to generate the xml documentation for your project and give it to your friend. If both files (assembly and xml documentation) are in the same directory Visual Studio will use the documentation in IntelliSense.

(Xml documentation can't be embedded in assembly)

like image 196
Julien Hoarau Avatar answered Oct 12 '22 09:10

Julien Hoarau


You need to build the XML documentation file for the project as well (tick the box in the Build part of the project properties) and give your friends that file as well as the DLL.

If they put the two files in the same directory, Visual Studio will pick up the documentation automatically and show it in IntelliSense etc.

Note that this will only pick up XML comments (the ones started with /// or /**), not regular comments.

like image 23
Jon Skeet Avatar answered Oct 12 '22 10:10

Jon Skeet