Solved

Xml comments in intellisense tooltip for dotnet 2.0 assembly

Posted on 2008-06-25
12
789 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
12 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
 
LVL 18

Expert Comment

by:philipjonathan
ID: 21872995
Any example of other people managed to do so?
0
Highfive + Dolby Voice = No More Audio Complaints!

Poor audio quality is one of the top reasons people don’t use video conferencing. Get the crispest, clearest audio powered by Dolby Voice in every meeting. Highfive and Dolby Voice deliver the best video conferencing and audio experience for every meeting and every room.

 

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 500 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

How to run any project with ease

Manage projects of all sizes how you want. Great for personal to-do lists, project milestones, team priorities and launch plans.
- Combine task lists, docs, spreadsheets, and chat in one
- View and edit from mobile/offline
- Cut down on emails

Join & Write a Comment

This document covers how to connect to SQL Server and browse its contents.  It is meant for those new to Visual Studio and/or working with Microsoft SQL Server.  It is not a guide to building SQL Server database connections in your code.  This is mo…
Introduction In my previous article (http://www.experts-exchange.com/Microsoft/Development/MS-SQL-Server/SSIS/A_9150-Loading-XML-Using-SSIS.html) I showed you how the XML Source component can be used to load XML files into a SQL Server database, us…
This video gives you a great overview about bandwidth monitoring with SNMP and WMI with our network monitoring solution PRTG Network Monitor (https://www.paessler.com/prtg). If you're looking for how to monitor bandwidth using netflow or packet s…
This video explains how to create simple products associated to Magento configurable product and offers fast way of their generation with Store Manager for Magento tool.

744 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

Need Help in Real-Time?

Connect with top rated Experts

12 Experts available now in Live!

Get 1:1 Help Now