Inheriting XML Comments

[Tim Haughton]

Open question - is it possible to inherit comments along with an interface
or class??

For example - I have a class that implements IXPathNavigable. When VS
creates te method stub for me, it would be nice if by default, it would add
the comments for that method that are present on the interface.

This is perhaps more useful when I'm implementing one of our own interfaces.
I do find myself copying the comments from the interface across to the
class.

Perhaps a <inherit> comment tag would be nice. As we produce an xml comment
file for all our public API's, this would instruct VS to use the comments
from the base class.

Cheers,

Tim H

[Tim Haughton]

Thanks for the reply David. I'm not sure what you mean, could you elaborate?

Cheers,

Tim H

"David Williams" <Da***********@discussions.microsoft.com> wrote in message
news:58**********************************@microsof t.com...

You could move the XML comments to a separate file and use an <include ....> tag to point to the same location.
HTH
--
David Williams, VB.NET MVP
"Tim Haughton" wrote:

Open question - is it possible to inherit comments along with an interface or class??

For example - I have a class that implements IXPathNavigable. When VS
creates te method stub for me, it would be nice if by default, it would add the comments for that method that are present on the interface.

This is perhaps more useful when I'm implementing one of our own interfaces. I do find myself copying the comments from the interface across to the
class.

Perhaps a <inherit> comment tag would be nice. As we produce an xml comment file for all our public API's, this would instruct VS to use the comments from the base class.

Cheers,

Tim H

[Tim Haughton]

Thanks for the reply David. I'm not sure what you mean, could you elaborate?

Cheers,

Tim H

"David Williams" <Da***********@discussions.microsoft.com> wrote in message
news:58**********************************@microsof t.com...

You could move the XML comments to a separate file and use an <include ....> tag to point to the same location.
HTH
--
David Williams, VB.NET MVP
"Tim Haughton" wrote:

Open question - is it possible to inherit comments along with an interface or class??

For example - I have a class that implements IXPathNavigable. When VS
creates te method stub for me, it would be nice if by default, it would add the comments for that method that are present on the interface.

This is perhaps more useful when I'm implementing one of our own interfaces. I do find myself copying the comments from the interface across to the
class.

Perhaps a <inherit> comment tag would be nice. As we produce an xml comment file for all our public API's, this would instruct VS to use the comments from the base class.

Cheers,

Tim H