<summary> tags not showing up in intellisense / tooltips

[carl.manaster]

Hi,

Within my project, I've got a number of classes in separate files.
When I point at the name of a class in the file in which it is defined,
it shows the <summary> information for the class in a tooltip. But
when I point at the name of a class in some other file (still in the
same project), it just shows "class " and the name of the class. I
looked into generating an XML file, but it produced a bunch of errors
because I don't have comments for every single method of every single
class (none, actually, for the methods). Is the lack of an XML file
why it can't display class comments in tooltips and intellisense?
Thanks,
--Carl

 

[Hans Kesting]

Hi,

Within my project, I've got a number of classes in separate files.
When I point at the name of a class in the file in which it is
defined, it shows the <summary> information for the class in a
tooltip. But when I point at the name of a class in some other file
(still in the same project), it just shows "class " and the name of
the class. I looked into generating an XML file, but it produced a
bunch of errors because I don't have comments for every single method
of every single class (none, actually, for the methods). Is the lack
of an XML file why it can't display class comments in tooltips and
intellisense? Thanks,
--Carl

Did you REbuild the project? If you just "build" then you will get a compiler
warning stating that the documentation files will not be updated.
So try a rebuild of (at least) the project. This should recreate the xml files.
It is not a problem if you didn't comment everything.

By the way: you don't get "errors" about missing comments, those
are "warnings". The code will work just as well without those comments
as with them.

Hans Kesting

 

[carl.manaster]

Hi, Hans,

By the way: you don't get "errors" about missing
comments, those are "warnings". The code will work
just as well without those comments

Thank you, but I've got the option set to "Treat all warnings as
errors" - and unfortunately it seems to apply to XML generation as well
as compilation. I think I'll just pass on the XML generation, but
thanks for the info.

Peace,
--Carl