473,385 Members | 1,569 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,385 software developers and data experts.

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 1641
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****************@tk2msftngp13.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*****@microsoft.com> schrieb im Newsbeitrag
news:eG**************@TK2MSFTNGP12.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****************@tk2msftngp13.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
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...
9
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
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....
7
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...
0
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...
1
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...
2
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...
2
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...
1
by: CloudSolutions | last post by:
Introduction: For many beginners and individual users, requiring a credit card and email registration may pose a barrier when starting to use cloud servers. However, some cloud server providers now...
0
by: ryjfgjl | last post by:
In our work, we often need to import Excel data into databases (such as MySQL, SQL Server, Oracle) for data analysis and processing. Usually, we use database tools like Navicat or the Excel import...
0
by: aa123db | last post by:
Variable and constants Use var or let for variables and const fror constants. Var foo ='bar'; Let foo ='bar';const baz ='bar'; Functions function $name$ ($parameters$) { } ...
0
by: ryjfgjl | last post by:
If we have dozens or hundreds of excel to import into the database, if we use the excel import function provided by database editors such as navicat, it will be extremely tedious and time-consuming...
0
by: ryjfgjl | last post by:
In our work, we often receive Excel tables with data in the same format. If we want to analyze these data, it can be difficult to analyze them because the data is spread across multiple Excel files...
0
BarryA
by: BarryA | last post by:
What are the essential steps and strategies outlined in the Data Structures and Algorithms (DSA) roadmap for aspiring data scientists? How can individuals effectively utilize this roadmap to progress...
1
by: nemocccc | last post by:
hello, everyone, I want to develop a software for my android phone for daily needs, any suggestions?
1
by: Sonnysonu | last post by:
This is the data of csv file 1 2 3 1 2 3 1 2 3 1 2 3 2 3 2 3 3 the lengths should be different i have to store the data by column-wise with in the specific length. suppose the i have to...
0
by: Hystou | last post by:
There are some requirements for setting up RAID: 1. The motherboard and BIOS support RAID configuration. 2. The motherboard has 2 or more available SATA protocol SSD/HDD slots (including MSATA, M.2...

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.