XML doc visibility

Thread view:

Enable EMail Alerts

Start New Thread

Thread rating:

Jon Shemitz - 11 Mar 2005 03:44 GMT

My /// comments only show up in tooltips when the commented member is
in the same assembly, not when my code is in a library assembly. Yet,
FCL (and some 3rd party) /// comments do show up in tooltips.

How do I get my /// comments to show across assembly boundaries?

Signature

www.midnightbeach.com

Reply to this Message

Jon Shemitz - 16 Mar 2005 03:47 GMT

> My /// comments only show up in tooltips when the commented member is
> in the same assembly, not when my code is in a library assembly. Yet,
> FCL (and some 3rd party) /// comments do show up in tooltips.
>
> How do I get my /// comments to show across assembly boundaries?

Right click on the library project in the VS.2003 Solution Explorer
and select Properties, then Configuration Properties / Build, and set
the "XML Documentation File" to the "Assembly Name" followed by .xml
(e.g. "MyLibrary.xml") - and save the change - then you will get
tooltips, the next time you start up VS.

Doing this ALSO gives you a warning for every public member without a
/// comment, and for every bit of bad XML in a /// comment.

Signature

www.midnightbeach.com

Reply to this Message

Free Magazines

Get these publications absolutely FREE for up to 12 months. There are no hidden fees and no obligation. Simply choose a title, complete the application form and submit it. Read more ...