我是否应记录异常,即使它们已在其界面中记录?

时间:2018-05-24 15:19:02

标签: c# resharper documentation

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) 
    {
    }
}

1 个答案:

答案 0 :(得分:0)

您应该向CantMoveForwardException类添加注释。这是一个简单的选项:

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