Logo Home   Documents and Lists   Create   Site Settings   Help   
Icon
Dan Kohls' Weblog
Blog: Problem with Intellisense and XML documentation...
   
New New Item
|
Edit Edit Item
|
Delete Delete Item
|
Alert Me
|
Go Back to List
Title:
Problem with Intellisense and XML documentation in class library
Body:
 
Intellisense
The Intellisense feature in the Microsoft Development Environment need some cajoling to display parameter comments from class libraries.
The problem
You diligently create summary comments, but they are not displayed by Intellisense when you're editing code in other projects.
IntelliSense works correctly if you're working within the same project, but not other projects within the same solution.
The solution
The class library project must generate an XML Documentation File.
  1. Go to the assembly project (DLL Library) properties within the solution
  2. Change Configuration Properties. Set Configuration to "All Configurations". Go to Build | XML Documentation File.
  3. Set this field to exactly the same name as the assembly, adding the extent “.xml”.  The name must match the DLL name or IntelliSense will not find it!
  4. Perform a “Rebuild Solution”. The environment will create an XML Documentation File, and copy it to the start up project bin directory, along with the associated assembly dll.
  5. Close the Microsoft Development Environment. Yes, close it.
  6. Run the Microsoft Development Environment...…and all should be fine. IntelliSense will now correctly display all summary comments


Draft:
No
Attachments:
 
 
Created at 5/2/2006 1:40 PM by Dan Kohls
Last modified at 5/2/2006 1:40 PM by Dan Kohls