【问题标题】:Should I document Exceptions even though they are already documented in their Interface?我是否应该记录异常,即使它们已经记录在他们的界面中?
【发布时间】:2018-05-24 15:19:01
【问题描述】:

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

【问题讨论】:

  • CantMoveForwardException 类可能没有文档。你的其他 cmets 很好。

标签: c# resharper documentation


【解决方案1】:

您应该将 cmets 添加到 CantMoveForwardException 类。这是一个简单的选项:

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

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2010-09-10
    • 1970-01-01
    • 2013-11-30
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多