Question

是否有更新文档注释的标准方法以反映子类的名称而不是基类？此外，如果确实存在某种方法，这是我应该练习还是避免的事情？

示例：

class BaseClass
{
    /// <summary>
    /// Gets or sets a value associated with the name of the BaseClass
    /// </summary>
    protected string Name { get; set; }
}

class SubClass : BaseClass
{
    /// Gets or sets a value associated with the name of the Subclass <-- updated
    /// protected string Name { get; set; } <-- defined on BaseClass
}

Answer 1

没有。该文档仅适用于已实现的代码 - 如果您的类从其基类继承了一个方法，那么该文档也会被继承。你无法覆盖＆＃39;文档没有提供新的实现。（这是有道理的 - 如果实施没有改变，那么文档也不需要改变。）

如果您在外部表单或智能感知中浏览文档，基类中的文档将根据需要显示，因此无需重新定义它们以查看相应的文档。

Answer 2

如果您使用Sandcastle Help File Builder，则可以使用<inheritdoc/> tag在某种程度上重复使用说明。例如，您可以在基类上设置摘要，并在派生类上使用<inheritdoc/>来获取相同的内容。但是，我认为没有办法动态地更改它（例如替换类名） - 您要么继承整个摘要文本，要么不继承。

文档注释（子类）

2 个答案: