How to add struct comments?

B

Brett Romero

I have several structs in a DLL. When I reference this DLL in other
projects and point to any of the structs, none of the comments I've
placed with them appear. For example:

/// <summary>
/// Tracker="someserver\CORE_SQL_TEST_1"
/// Project="someserver\CORE_SQL_TEST_1"
/// </summary>
public struct Server
{
/// <summary>
/// someserver\CORE_SQL_TEST_1
/// </summary>
public static string Tracker=@"someserver\CORE_SQL_TEST_1";
/// <summary>
/// someserver\CORE_SQL_TEST_1
/// </summary>
public static string Project=@"someserver\CORE_SQL_TEST_1";
}

None of the above will appear as it does for classes and methods. Is
this a limitation on structs?

Thanks,
Brett
 
P

Peter Rilling

Do you get comments displayed for any classes or methods in that particular
assembly?

You need to make sure you have the XML file bearing the same name as the
assembly in order for the comments to appears.
 
B

Brett Romero

There isn't an XML file there. I just comments on another class and
see they don't come through in projects that are referencing that
class. It also doesn't have an XML file.

I've added the XML file to all of my projects and rebuit each.
However, I still don't see the comments coming through. I think the
problem is more the project not refreshing its DLL references. For one
particular project, it does have the latest version of a DLL, yet the
comments are coming through. Any suggestions?

Thanks,
Brett
 
B

Brett Romero

Seems I had to delete both my bin and obj folders before the update
came through. That's the only way I see changes in the DLLs.
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Top