Go Premium for a chance to win a PS4. Enter to Win

x
?
Solved

Xml comments in intellisense tooltip for dotnet 2.0 assembly

Posted on 2008-06-25
12
Medium Priority
?
817 Views
Last Modified: 2013-12-16
In VS.NET, IntelliSense shows the documentation for [almost] every
system-defined class/method/param. For example: when I'm writing a call to a
method, I see a description of every parameter in a nice tooltip.

I defined a C# class and documented it with XML comments. When I use this
class from code in the *same project*, IntelliSense works fine, and shows my
my XML comments in the tooltips.

But: when I reference the assembly containing my class in another project,
bye-bye XML comments: they just don't show up in the tooltips.

Why? I think I know: it is because the XML comments are not compiled into
the resulting assembly, so they are simply not available to the project
referencing the assembly.

But then: why and how does IntelliSense know what to show in the tooltips
for system classes? (like FileStream, for instance).

How can I build an assembly that, when used by a 3rd party, will be able to
show comments into IntelliSense's tooltips?
0
Comment
Question by:SwamyN
  • 5
  • 3
8 Comments
 
LVL 18

Expert Comment

by:philipjonathan
ID: 21872390
1. Open your project properties by choosing from the menu: Project -> YourProjectName Properties...
2. On the left panel, browse to Configuration Properties -> Build
3. Under the "Outputs" section, enter the documentation file name into "XML Documentation File". Eg. "bin\Debug\YourDllName.dll.xml"

ps. Make sure that the file resides in the same path as your dll.
0
 
LVL 18

Expert Comment

by:philipjonathan
ID: 21872398
I assume you are already using XML comments, aren't you? If not, just try typing "///" above a class or method declaration.
0
 

Author Comment

by:SwamyN
ID: 21872766
actually, i am able to generate xml documentation file.
but if i want my dll to be consumed on some other system/ project, i don't get the xml comments in tooltip of intellisense.

i know that xml file is required at same location where the dll is deployed/used from.

but i want that the xml documentation file be embedded with the dll ( assembly) so that i can pass on only the dll ( single file & not the xml file).
0
VIDEO: THE CONCERTO CLOUD FOR HEALTHCARE

Modern healthcare requires a modern cloud. View this brief video to understand how the Concerto Cloud for Healthcare can help your organization.

 
LVL 18

Expert Comment

by:philipjonathan
ID: 21872995
Any example of other people managed to do so?
0
 

Author Comment

by:SwamyN
ID: 21873712
i am asking for the solution, that how to achieve.
i don't have any example.
0
 
LVL 18

Accepted Solution

by:
philipjonathan earned 2000 total points
ID: 21876545
I don't think that can be done
0
 

Author Comment

by:SwamyN
ID: 21881389
ok
0
 
LVL 18

Expert Comment

by:philipjonathan
ID: 22203912
Objection.

I believe my comment has answered the original question correctly ID:21872390.
As for the follow up question, I believe "no" is the answer, as I commented in ID:21876545

Please kindly re-consider to accept those 2 comments as the answers.
0

Featured Post

Keep up with what's happening at Experts Exchange!

Sign up to receive Decoded, a new monthly digest with product updates, feature release info, continuing education opportunities, and more.

Question has a verified solution.

If you are experiencing a similar issue, please ask a related question

Many of us here at EE write code. Many of us write exceptional code; just as many of us write exception-prone code. As we all should know, exceptions are a mechanism for handling errors which are typically out of our control. From database errors, t…
A long time ago (May 2011), I have written an article showing you how to create a DLL using Visual Studio 2005 to be hosted in SQL Server 2005. That was valid at that time and it is still valid if you are still using these versions. You can still re…
In response to a need for security and privacy, and to continue fostering an environment members can turn to for support, solutions, and education, Experts Exchange has created anonymous question capabilities. This new feature is available to our Pr…
We’ve all felt that sense of false security before—locking down external access to a database or component and feeling like we’ve done all we need to do to secure company data. But that feeling is fleeting. Attacks these days can happen in many w…
Suggested Courses

876 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question