Должен ли я документировать исключения, даже если они уже задокументированы в их интерфейсе?

Question

ReSharper предупреждает меня, говоря, что мое исключение не задокументировано.Когда я использую инструмент быстрой документации ReSharper (связывание клавиш по умолчанию CTRL + Q ), он ясно показывает исключение унаследованной документации.

Так что мне интересно.Это проблема с ReSharper или я должен объявить об исключении снова?

---

Мой код разбит на важные части

public interface IMyService 
{
    /// <summary>...</summary>
    /// <exception cref="CantMoveForwardException">
    ///     If <see cref="CanMoveForward"/> returns <see langword="false" />.
    /// </exception>
    void MoveForward();
}

public class MyService : IMyService 
{
    public void MoveForward()
    {
    }
}

public sealed class CantMoveForwardException : Exception
{
    public CantMoveForwardException(string message) : base(message) 
    {
    }
}

Answer 1

Вы должны добавить комментарии к классу CantMoveForwardException.Вот простой вариант:

/// <inheritdoc/>
public sealed class CantMoveForwardException : Exception
{
    /// <inheritdoc/>
    public CantMoveForwardException(string message) : base(message) 
    {
    }
}