Partial inheriting of xml-comments with included <inheritdoc/>

Question

I just found out that is now included by default in visual studio. So I started writing comments for my class which makes extensive use of inheritance. What I am trying to do is inherit only parts of my decription from above. So for example when writting xml-comments for the constructor of an inherited class, I want him to inherit the description for my parameters but want to specify an more specific comment for the summary field. I tried this approch but unfortunally it doesn't worked:

    ''' <summary>
''' Creates a new belt-instance
''' </summary>
''' <param name="OpcClient"><inheritdoc/></param>
''' <param name="BaseNode"><inheritdoc/></param>
''' <param name="PropertyChangedNotificationsRequested"><inheritdoc/>/param>
Sub New(ByRef OpcClient As OpcUaClient, ByVal BaseNode As OpcNodeId, ByVal PropertyChangedNotificationsRequested As Boolean)
    MyBase.New(OpcClient, BaseNode, PropertyChangedNotificationsRequested)
    ...
End Sub

Always inheriting the the whole comment seemt to be a bit overdone, because the more you go uo the inheritance-chain, the mor general and unspecific the comments get most of the time. How to achieve that kind of partial inheritance of comments?

Stef · Accepted Answer · 2020-10-26 10:35:37Z

3

I haven't found a solution in internet, but tried a bit with different solutions. The following one seems to work

Add all things you want to override.
Add the afterwards.

Example:

    ''' <summary>
''' I am overriding
''' </summary>
''' <param name="BaseNode">I am also</param>
''' <inheritdoc/>
Sub New(ByRef OpcClient As OpcUaClient, ByVal BaseNode As OpcNodeId, ByVal PropertyChangedNotificationsRequested As Boolean)
    MyBase.New(OpcClient, BaseNode, PropertyChangedNotificationsRequested)
    ...
End Sub

If there is also a more clean solution or some additional information regarding this case I would like to hear about it.

answered Oct 26, 2020 at 10:35

Stef

8310 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Partial inheriting of xml-comments with included <inheritdoc/>

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related