【问题标题】:Partial inheriting of xml-comments with included <inheritdoc/>部分继承包含 <inheritdoc/> 的 xml-comments
【发布时间】:2021-02-08 10:44:31
【问题描述】:

我刚刚发现它现在默认包含在 Visual Studio 中。所以我开始为我的类编写 cmets,它广泛使用了继承。我想做的只是从上面继承我的部分描述。因此,例如,在为继承类的构造函数编写 xml-cmets 时,我希望他继承我的参数的描述,但想为汇总字段指定更具体的注释。我尝试了这种方法,但不幸的是它不起作用:

    ''' <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

总是继承整个评论似乎有点过头了,因为你越是继承链,cmets 大部分时间就越笼统和不具体。 如何实现这种cmets的部分继承?

【问题讨论】:

    标签: c# vb.net visual-studio inheritance comments


    【解决方案1】:

    我还没有在互联网上找到解决方案,但尝试了一些不同的解决方案。以下一个似乎有效

    1. 添加您想要覆盖的所有内容。
    2. 之后添加。

    例子:

        ''' <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
    

    如果还有更干净的解决方案或有关此案例的一些其他信息,我想听听。

    【讨论】:

      猜你喜欢
      • 2010-11-17
      • 1970-01-01
      • 1970-01-01
      • 2021-12-09
      • 1970-01-01
      • 2020-01-15
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多