locked
How to see XML comments RRS feed

  • Question

  • Hi

    I have many detailed XML comments inside a large set of classes, these are all processed as well by Document X as part of published product docs.

    However, if I write some code that uses any of these classes, I'd expect to see the comments with intellisense, I can do this for Microsoft classes, methods etc.

    When I hover the mouse over my classes, methods etc that are in my library DLL, I see no comment info.

    Can anyone shed light on this or point me to a MS page that explains how to overcome this?

    Thx
    Wednesday, April 29, 2009 2:41 PM

All replies

  • Hi,

    Your comments in <summary> tags and a few other tags, such as <param> and <returns>, will show in IntelliSense if Visual Studio can locate your assembly's XML documentation file (generated by the compiler).  If the project in which you'd like to see IntelliSense references your assemblies using Assembly References, as opposed to Project References, then make sure the XML documentation files for those assemblies are in the same folder as the assemblies themselves.  For example:

    {Root}
        External References\
             Lib1\
                   Lib1.dll
                   Lib1.xml
             Lib2\
                   Lib2.dll
                   Lib2.xml
         Main\
              MyApp\
                   References
                         ..\..\External References\Lib1\Lib1.dll
                         ..\..\External References\Lib2\Lib2.dll

    - Dave
    http://davesexton.com/blog
    Thursday, April 30, 2009 2:10 AM