Tek-Tips is the largest IT community on the Internet today!

Members share and learn making Tek-Tips Forums the best source of peer-reviewed technical information on the Internet!

  • Congratulations derfloh on being selected by the Tek-Tips community for having the most helpful posts in the forums last week. Way to Go!

Creating a DLL that displays discriptive documentation when used.

Status
Not open for further replies.

cerlendson

Programmer
Joined
May 4, 2004
Messages
2
Location
CA
I created a DLL and I used descriptive documentation in it. By "descriptive documentation" I mean that I put the following documentaion in above all of my proceedures:

/// <summary>
/// example proceedure discription
/// </summary>
public void example()
{
....
}

But when I complile the DLL and then reference it in another program I can't get the discription to come up in visual studio. You know how when you type in a class and then hit "." all the members come up with thier summaries? That is what I want to happen with the class in my DLL.

Any sugestions?
 
Add this line:

Code:
/// <summary>
/// example proceedure discription
/// </summary>
[System.ComponentModel.Description("example procedure description")]
public void example()
{
....
}

-----------------------------------------------
"The night sky over the planet Krikkit is the least interesting sight in the entire universe."
-Hitch Hiker's Guide To The Galaxy
 
I dunno, works for me.

Try going into your project properties (right-click on project in solution pane), then under Configuration Properties | Build, enter in a path for the documentation file.

Chip H.


If you want to get the best response to a question, please check out FAQ222-2244 first
 
That doesn't seem to be working for me. But even if I do get it to work, how do I get it to display the different parameter discriptions for the proceedure?
 
Status
Not open for further replies.

Part and Inventory Search

Sponsor

Back
Top