473,574 Members | 3,144 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

Broken Intellisense for users of my API

Hi All,

I have created an API in C# for developers to use at my workplace, and have
commented it fully. If I reference the DLL in a new class in my API
project, I get full intellisense on the methods, descriptions and
everything.

If I make a new project and include my API DLL, I do get Intellisense popus,
but they are missing the descriptions I created. ( I see only the method
signatures)

Ideas? Thanks in advance...
Nov 16 '05 #1
3 1504
notayoda,

When you compile your DLL, you should make sure that you have the
project setting to generate XML documentation set. When you do this, it
will generate a file with an XML extension that has the name of your output
file (minus the DLL extension).

When referencing your assembly, if that XML file is in the same
directory, then Intellisense will pick up the comments, and display them in
the editor.

Hope this helps.
--
- Nicholas Paldino [.NET/C# MVP]
- mv*@spam.guard. caspershouse.co m

"notayoda" <sr************ *@hotmail.com> wrote in message
news:eW******** ******@TK2MSFTN GP12.phx.gbl...
Hi All,

I have created an API in C# for developers to use at my workplace, and
have commented it fully. If I reference the DLL in a new class in my API
project, I get full intellisense on the methods, descriptions and
everything.

If I make a new project and include my API DLL, I do get Intellisense
popus, but they are missing the descriptions I created. ( I see only the
method signatures)

Ideas? Thanks in advance...

Nov 16 '05 #2
notayoda <sr************ *@hotmail.com> wrote:
I have created an API in C# for developers to use at my workplace, and have
commented it fully. If I reference the DLL in a new class in my API
project, I get full intellisense on the methods, descriptions and
everything.

If I make a new project and include my API DLL, I do get Intellisense popus,
but they are missing the descriptions I created. ( I see only the method
signatures)

Ideas? Thanks in advance...


You need to also build the XML documentation file (specify it in the
project build configuration) and make sure it's got the same name as
the assembly (but with a .xml extension instead of .dll). Ship it to
your users along with the assembly.

--
Jon Skeet - <sk***@pobox.co m>
http://www.pobox.com/~skeet
If replying to the group, please do not mail me too
Nov 16 '05 #3
Yep, that did the trick! Thanks!

Project Properties ->Configuratio n Properties->Build
Outputs
XML Documentation file (type in name of your DLL here)
When you build this will create an XML file along with your DLL.

To use your DLL with comments enabled in a new project, reference the DLL in
the project and make sure that you have this xml file in the same folder as
the referenced DLL.

"Nicholas Paldino [.NET/C# MVP]" <mv*@spam.guard .caspershouse.c om> wrote in
message news:%2******** ********@TK2MSF TNGP10.phx.gbl. ..
notayoda,

When you compile your DLL, you should make sure that you have the
project setting to generate XML documentation set. When you do this, it
will generate a file with an XML extension that has the name of your
output file (minus the DLL extension).

When referencing your assembly, if that XML file is in the same
directory, then Intellisense will pick up the comments, and display them
in the editor.

Hope this helps.
--
- Nicholas Paldino [.NET/C# MVP]
- mv*@spam.guard. caspershouse.co m

"notayoda" <sr************ *@hotmail.com> wrote in message
news:eW******** ******@TK2MSFTN GP12.phx.gbl...
Hi All,

I have created an API in C# for developers to use at my workplace, and
have commented it fully. If I reference the DLL in a new class in my API
project, I get full intellisense on the methods, descriptions and
everything.

If I make a new project and include my API DLL, I do get Intellisense
popus, but they are missing the descriptions I created. ( I see only the
method signatures)

Ideas? Thanks in advance...


Nov 16 '05 #4

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

8
2394
by: andrew.queisser | last post by:
Yesterday I typed in some C++ code that called a function with two ints. Intellisense (auto-complete) helpfully told me that the first formal parameter was called "frontLight" and the second "ringLight". It occurred to me that I'm getting some semantic help here on top of the obvious type safety. It seems to me that the existance of this kind...
9
2674
by: Ulf Lindback | last post by:
Hi! We have an application surveillance product with a number of API's for different languages; one of them is a C API. Now I wonder how we can supply intellisense to our Visual Studio.Net (native C/C++) users (preferably both VS 7.0 and 7.1). I would like to have something like the parameter info you get for e.g. printf when you enter...
0
1106
by: Paulus | last post by:
Anyone have any luck with this one ? The grid is a c# dll, ILDASM shows all the methods fine, so they are all in the dll. Hitting ultragrid1-> in vis studio gives the messag Intellisense: 'Expression to the left of . or -> has a type which could not be resolved This should not be c++ problem, as the project is virtually empty, and on other...
1
2449
by: itp | last post by:
Hello, I have looked at several ADO.NET resources and they all say to use the infomessage event handler. I have added the code to my form but when I disconnect the network cable, it does not fire. I have also read that infomessage is for server error messages below 10. I have tested this by creating a stored proc that raises a custom...
0
7805
marktang
by: marktang | last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However, people are often confused as to whether an ONU can Work As a Router. In this blog post, we’ll explore What is ONU, What Is Router, ONU & Router’s main...
0
7726
by: Hystou | last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can effortlessly switch the default language on Windows 10 without reinstalling. I'll walk you through it. First, let's disable language...
1
7815
by: Hystou | last post by:
Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows Update option using the Control Panel or Settings app; it automatically checks for updates and installs any it finds, whether you like it or not. For...
0
6452
agi2029
by: agi2029 | last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing, and deployment—without human intervention. Imagine an AI that can take a project description, break it down, write the code, debug it, and then...
1
5620
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome a new presenter, Adolph Dupré who will be discussing some powerful techniques for using class modules. He will explain when you may want to use classes...
0
3740
by: TSSRALBI | last post by:
Hello I'm a network technician in training and I need your help. I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs. The last exercise I practiced was to create a LAN-to-LAN VPN between two Pfsense firewalls, by using IPSEC protocols. I succeeded, with both firewalls in...
0
3749
by: adsilva | last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
1
2243
by: 6302768590 | last post by:
Hai team i want code for transfer the data from one system to another through IP address by using C# our system has to for every 5mins then we have to update the data what the data is updated we have to send another system
1
1339
muto222
by: muto222 | last post by:
How can i add a mobile payment intergratation into php mysql website.

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.