Improve company productivity with a Business Account.Sign Up

x
?
Solved

Xml comments in intellisense tooltip for dotnet 2.0 assembly

Posted on 2008-06-25
12
Medium Priority
?
822 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
Free Tool: ZipGrep

ZipGrep is a utility that can list and search zip (.war, .ear, .jar, etc) archives for text patterns, without the need to extract the archive's contents.

One of a set of tools we're offering as a way to say thank you for being a part of the community.

 
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

Free Tool: ZipGrep

ZipGrep is a utility that can list and search zip (.war, .ear, .jar, etc) archives for text patterns, without the need to extract the archive's contents.

One of a set of tools we're offering as a way to say thank you for being a part of the community.

Question has a verified solution.

Are you are experiencing a similar issue? Get a personalized answer when you ask a related question.

Have a better answer? Share it in a comment.

Join & Write a Comment

This article shows how to deploy dynamic backgrounds to computers depending on the aspect ratio of display
Hello there! As a developer I have modified and refactored the unit tests which was written by fellow developers in the past. On the course, I have gone through various misconceptions and technical challenges when it comes to implementation. I would…
Watch the video of Kernel Migrator for SharePoint, which demonstrate the process easily of migration from SharePoint to SharePoint, OneDrive for Business & Google Drive servers, Public Folder to SharePoint, File Server to SharePoint. The tool has va…
From store locators to asset tracking and route optimization, learn how leading companies are using Google Maps APIs throughout the customer journey to increase checkout conversions, boost user engagement, and optimize order fulfillment. Powered …

595 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