.dll help strings

[Lou]

How do I add help strings to my .dll functions in C#

-Lou

 

[Marco Martin]

you mean like a tool tip or a method summary for developper. if you want a
method summary for a developper, just type "///" on the line above your
method declaration and type what you want inside the <sumary> tags

Marco

 

[Lou]

I want it to show up in the Object browser underneath the name of the
function?

 

[Lou]

The summary shows up in the .NET environment Object Browser. But I have an
interface that
I use to wrap it up as a COM componenet. I tried the tags there but the help
string doesn't show up
in my VB6 environment when i reference the C# object in my VB6 project???

 

[Eric Gunnerson [MS]]

You need to:

1) Turn on XML comments in the project properties.
2) Give it the same name as the dll (ie util.xml for util.dll)
3) Copy the file to the same location as the dll.

If you do that, it will work. You may not need to do step #3 - you don't
have to in the C# to C# case; I'm not sure whether you have to in the VB to
C# case.

--
Eric Gunnerson

Visit the C# product team at http://www.csharp.net
Eric's blog is at http://blogs.gotdotnet.com/ericgu/

This posting is provided "AS IS" with no warranties, and confers no rights.

 

[Lou]

That didn't work. the file was created with the same name as the .dll in
the same
directory as the .dll but the comments
still don't show up in th eVB object browser???

-Lou