Комментарии к документации (подкласс)

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

Если вы используете Sandcastle Help File Builder , вы можете достичь некоторой степени повторного использования описаний, используя тег <inheritdoc/> . Например, вы можете установить сводку для вашего базового класса и просто использовать <inheritdoc/> в своем производном классе, чтобы взять то же самое. Однако я не думаю, что есть способ изменить это динамически (например, заменить имя класса) & ndash; Вы либо наследуете весь текст резюме, либо нет.

Answer 2

Нет. Документация применяется только к реализованному коду - если ваш класс наследует метод от своего базового класса, то документация также наследуется. Вы не можете переопределить документацию, не предоставив также новую реализацию. (хотя это имеет смысл - если реализация не изменилась, то и документы не нужно менять).

Если вы просматриваете документы во внешней форме или в intellisense, документы из базового класса будут отображаться по мере необходимости, поэтому нет необходимости переопределять их, чтобы увидеть соответствующие документы.