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... 3 1505
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...
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
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...
This thread has been closed and replies have been disabled. Please start a new discussion. Similar topics |
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...
|
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...
|
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...
|
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...
|
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...
| |
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...
|
by: jinu1996 |
last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven tapestry of website design and digital marketing. It's not merely about having a website; it's about crafting an immersive digital experience that...
|
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...
|
by: tracyyun |
last post by:
Dear forum friends,
With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each protocol has its own unique characteristics and advantages, but as a user who is planning to build a smart home system, I am a bit confused by the...
|
by: conductexam |
last post by:
I have .net C# application in which I am extracting data from word file and save it in database particularly. To store word all data as it is I am converting the whole word file firstly in HTML and then checking html paragraph one by one.
At the time of converting from word file to html my equations which are in the word document file was convert...
|
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...
| |
by: adsilva |
last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
|
by: muto222 |
last post by:
How can i add a mobile payment intergratation into php mysql website.
| |