asked on

500pts: XML comments not being displayed in vs 2003 ide

Hi there,

I wonder if anyone can help, i started documenting my code with xml comments like this..

      /// <summary>
            /// Load all values for a specific user
            /// </summary>
            /// <param name="user">A <see cref=”System.String”/> that represents the client code</param>
            public void LoadValues(string user)
            {

the above is part of an external class..

And i do this...      ClientCommon.CustomList list = new ClientCommon.CustomList(User.id);
                                    list.LoadValues(................

but the idea only displays the the method LoadValues accepts user.id which is of type string i don't get the param name or the summary in the ide

Any ideas?

Thanks in advance

ian

surajguptha

Try removing the summary of the loadvalues method and make a new summary using /// tab tab
Add the comments. Compile the assembly and check out if you get the description of each parameter when you do list.Loadvalues(.....

nepali

In Vsnet 2003
Right Click on Project Properties.
and select Build from Configuration Section. There should be a property called as XmlDocumen or something like that.. give the name of any xml file..
Sorry I can't remember the exact location of this project property at the moment as I don't have that IDE at the moment.
Do a build and u we see all the xml comments.

ianinspain

ASKER

Thanks both for the replies... I tried both things... but nothing shows up in intellisense...

Its really strange..

I did try putting in the property under build - Xml Documentation ... the filename of the assembly followed by .xml i.e. MyAssembly.xml

recompiled, removed the reference readded reference...

but still doesn't

I was trying to get into a habit of using xml comments for use in intellisense especially..

Strange..

Ian

nepali

hmm... can u check if that xml file is getting created with ur comments information in the build folder...

surajguptha

nepali,
What has the xml file being generated got anything to do with intellisense comments ? I dont think they are related. I may be wrong too. Can u explain?

nepali

The Intellisense feature uses the xml file.

hit this and check where it says the following para.
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cscomp/html/vcerrDocProcessDocumentationComments.asp

To use the generated .xml file for use with the IntelliSense feature, let the file name of the .xml file be the same as the assembly you want to support and then make sure the .xml file is in the same directory as the assembly. Thus, when the assembly is referenced in the Visual Studio project, the .xml file is found as well.

ianinspain

ASKER

Hi nepali... yep that was it... generated the xml file .... and readded the reference.. thanks

Does that mean i need to distribute the xml file to developers who wish to use my dll in there code, is this also valid for vs 2005'?

Ian

ASKER CERTIFIED SOLUTION

nepali

membership

This solution is only available to members.

To access this solution, you must be a member of Experts Exchange.

Start Free Trial