473,382 Members | 1,437 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,382 software developers and data experts.

Inheriting XML Comments

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
Jul 21 '05 #1
2 1897
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

Jul 21 '05 #2
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

Jul 21 '05 #3

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

11
by: Noah Coad [MVP .NET/C#] | last post by:
How do you make a member of a class mandatory to override with a _new_ definition? For example, when inheriting from System.Collections.CollectionBase, you are required to implement certain...
1
by: Tristan | last post by:
Hi, When summary comments are placed above methods in an interface, is it possible that these comments also correspond to the derived classes i.e. public myInterface { ///<summary> /// An...
6
by: Russell Mangel | last post by:
Jeffery Richter makes the following statement in two books, the first was written in 2004, the latter in 2002. "You should not define new exception classes derived from ApplicationException; use...
4
by: Alan Silver | last post by:
Hello, I am displaying product details on a page and am allowing the site owner to specify the style in which the product details are displayed. I am debating which of two approaches to use here...
2
by: Jim Heavey | last post by:
I amd playing around with inheritance a little in VB.Net If I create a new class which inherits from ListViewItem and I am only wanting to override the ToString Method. In this situation, If I...
2
by: Charles Law | last post by:
I want a set of controls that all have a border, like a group box. I thought I would create a base control containing just a group box from which my set of controls could inherit. Assuming that...
3
by: Alex Satrapa | last post by:
There's some mention in the (old!) documentation that constraints such as foreign keys won't include data from inheriting tables, eg: CREATE TABLE foo ( id SERIAL PRIMARY KEY ); CREATE TABLE...
1
by: Tim Haughton | last post by:
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...
17
by: Adrian Hawryluk | last post by:
Hi all, What is everyone's opinion of const inheriting? Should the object that a pointer is pointing at inherit the constness of the pointer? Such as in the case of a class having a pointer...
1
by: CloudSolutions | last post by:
Introduction: For many beginners and individual users, requiring a credit card and email registration may pose a barrier when starting to use cloud servers. However, some cloud server providers now...
0
by: Faith0G | last post by:
I am starting a new it consulting business and it's been a while since I setup a new website. Is wordpress still the best web based software for hosting a 5 page website? The webpages will be...
0
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 3 Apr 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome former...
0
by: Charles Arthur | last post by:
How do i turn on java script on a villaon, callus and itel keypad mobile phone
0
by: aa123db | last post by:
Variable and constants Use var or let for variables and const fror constants. Var foo ='bar'; Let foo ='bar';const baz ='bar'; Functions function $name$ ($parameters$) { } ...
0
by: ryjfgjl | last post by:
In our work, we often receive Excel tables with data in the same format. If we want to analyze these data, it can be difficult to analyze them because the data is spread across multiple Excel files...
0
by: emmanuelkatto | last post by:
Hi All, I am Emmanuel katto from Uganda. I want to ask what challenges you've faced while migrating a website to cloud. Please let me know. Thanks! Emmanuel
0
BarryA
by: BarryA | last post by:
What are the essential steps and strategies outlined in the Data Structures and Algorithms (DSA) roadmap for aspiring data scientists? How can individuals effectively utilize this roadmap to progress...
0
by: Hystou | last post by:
There are some requirements for setting up RAID: 1. The motherboard and BIOS support RAID configuration. 2. The motherboard has 2 or more available SATA protocol SSD/HDD slots (including MSATA, M.2...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.