c# - 文档注释(子类)

标签 c# documentation comments

是否有更新文档注释以反射(reflect)子类名称而不是基类名称的标准方法?另外,如果确实存在一种方法,我应该练习还是应该避免这种方法?

例子:

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
}

最佳答案

没有。该文档仅适用于已实现的代码——如果您的类从其基类继承了一个方法,那么该文档也将被继承。您不能在不提供新实现的情况下“覆盖”文档。 (虽然这是有道理的——如果实现没有改变,那么文档也不需要改变。)

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

关于c# - 文档注释(子类),我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/8320844/

相关文章:

c# - join 子句中的表达式之一的类型不正确

c# - 如何从 Firebase 获取 Item Key

c# - 有没有办法在 Visual Studio 调试器中查看对象的变量而不查看所有基类内容

javascript - 在 Angular 中将对象数组传递给 POST

eclipse - 如何在 Eclipse 中获取 Android API 文档

c++ - 如何交叉引用现有的 doxygen 文档?

c# - 评论会减慢我网页的执行时间吗?

javascript - Facebook 评论和点赞问题

f# - FSharp.Core 发行说明在哪里?

wordpress - 找到评论的帖子标题