473,569 Members | 2,562 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

No sourcecode documentation visible in Intellisense from my own class libraries


Hello,

Whenever I use methods from my class libraries I don't get any Intellisense support of the source documentation I supplied.
When I use the same code directly instead (i.e. adding the class directly to my project and not using the assembly dll of my class library) then I get Intellisense information of the methods as expected.

Using third party assemblies instead provides me with the intellisense support.

Is there something special I need to do with my assemblies to provide the same support?

My methods are always documented like this:

using MyClassLibrary

/// <summary>
/// Summary for MyMethod
/// </summary>
/// <param name="MyParam"> </param>
void MyMethod (int MyParam)
{
}

Any hints?

Many thanks in advance.

Roberto Rocco.
Jul 21 '05 #1
2 1657
You need to generate xml documentation for the referenced assembly. In
Visual Studio, you can enable this in the project properties. From the
command-line, you can use the /doc switch.

If your assembly is called X.dll, then put the documentation in X.xml and
place the file next to X.dll - then it should work.

Christian

---

"Roberto Rocco" <ro*****@rocco. de> wrote in message
news:%2******** ********@tk2msf tngp13.phx.gbl. ..

Hello,

Whenever I use methods from my class libraries I don't get any Intellisense
support of the source documentation I supplied.
When I use the same code directly instead (i.e. adding the class directly to
my project and not using the assembly dll of my class library) then I get
Intellisense information of the methods as expected.

Using third party assemblies instead provides me with the intellisense
support.

Is there something special I need to do with my assemblies to provide the
same support?

My methods are always documented like this:

using MyClassLibrary

/// <summary>
/// Summary for MyMethod
/// </summary>
/// <param name="MyParam"> </param>
void MyMethod (int MyParam)
{
}

Any hints?

Many thanks in advance.

Roberto Rocco.
Jul 21 '05 #2
Hello Christian,

thanks a lot for your reply. That was exactly the "missing link" I was
looking for!

Now I can see my docs from my assemblies.

Best regards,

Roberto.

"Christian Heide Damm" <ch*****@micros oft.com> schrieb im Newsbeitrag
news:eG******** ******@TK2MSFTN GP12.phx.gbl...
You need to generate xml documentation for the referenced assembly. In
Visual Studio, you can enable this in the project properties. From the
command-line, you can use the /doc switch.

If your assembly is called X.dll, then put the documentation in X.xml and
place the file next to X.dll - then it should work.

Christian

---

"Roberto Rocco" <ro*****@rocco. de> wrote in message
news:%2******** ********@tk2msf tngp13.phx.gbl. ..

Hello,

Whenever I use methods from my class libraries I don't get any
Intellisense support of the source documentation I supplied.
When I use the same code directly instead (i.e. adding the class directly
to my project and not using the assembly dll of my class library) then I
get Intellisense information of the methods as expected.

Using third party assemblies instead provides me with the intellisense
support.

Is there something special I need to do with my assemblies to provide the
same support?

My methods are always documented like this:

using MyClassLibrary

/// <summary>
/// Summary for MyMethod
/// </summary>
/// <param name="MyParam"> </param>
void MyMethod (int MyParam)
{
}

Any hints?

Many thanks in advance.

Roberto Rocco.

Jul 21 '05 #3

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

Similar topics

6
8084
by: Stefan Kronberg | last post by:
I'm working on a solution containing about 20 projects. Some of the projects contain class definitions that are used in other of the projects. Most of the time intellisense is working ok, i.e. if I work with objects declared from my own classes intellisense will show me all alternatives (methods and properties from my classes and from the...
9
1930
by: news.microsoft.com | last post by:
Dear all, I have to do a source code editor to implement syntax hilighted with special colors , IntelliSense function. Could anybody give me some tips or links? Thanks,
3
11863
by: David Martin | last post by:
Is there a way to insert a newline into a documentation comment? The intention is to have the tooltip that appears with Intellisense show the line breaks so that the description is easier to read. For example, I have a method where one of the parameters is a bool. The diference between true and false is significant to the results. I would...
7
1293
by: Lee Franke | last post by:
I am working on a custom app that has similar functionality as Intellisense but it does not use the Intellisense object. Can you use the Intellisense object? Has anyone done it? Any documentation (google has failed me on this so far)? thanks, lee
0
886
by: Ralf Jablonski | last post by:
Hello, using VC++ 2003 all source code comments in front of eg. a class method has been visible in intellisense and object browser. After converting the project to whidbey, the source code comments are no longer visible. I also tried the C# style XML tags without success. Has anybody have the same problem or any hint ?
1
1443
by: Lasse Vågsæther Karlsen | last post by:
I've been using XML Documentation in my class libraries since I discovered this, and I have been using NDoc to produce help files from the xml files so that the documentation is available outside of Visual Studio as well. With the introduction of .NET 2.0, generics, iterators, etc. NDoc seems to be behind in support for this. I've looked at...
2
233
by: Roberto Rocco | last post by:
Hello, Whenever I use methods from my class libraries I don't get any Intellisense support of the source documentation I supplied. When I use the same code directly instead (i.e. adding the class directly to my project and not using the assembly dll of my class library) then I get Intellisense information of the methods as expected. Using...
2
2695
by: Shehab Kamal | last post by:
I have a C# .NET 1.1 solution that consists of 2 projects. The first project is a class library that has well formed XML documenation. In this project IntelliSense shows me the description of each method. I have added a reference to this class library in the second project. But IntelliSense doesn't show me the description of any method. Note:...
0
7615
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...
0
7924
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed. This is as boiled down as I can make it. ...
0
7979
tracyyun
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...
0
6284
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
5514
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
5219
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...
0
3653
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...
1
1223
muto222
by: muto222 | last post by:
How can i add a mobile payment intergratation into php mysql website.
0
940
bsmnconsultancy
by: bsmnconsultancy | last post by:
In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence can significantly impact your brand's success. BSMN Consultancy, a leader in Website Development in Toronto offers valuable insights into creating...

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.