C# 即使异常已经记录在接口中,我也应该记录它们吗?
ReSharper向我发出警告,说我的异常没有记录在案。当我使用ReSharper的快速文档工具(默认键绑定CTRL+Q)时,它清楚地显示了继承文档的例外情况 所以我想知道。这是ReSharper的问题还是我应该再次声明异常C# 即使异常已经记录在接口中,我也应该记录它们吗?,c#,resharper,documentation,C#,Resharper,Documentation,ReSharper向我发出警告,说我的异常没有记录在案。当我使用ReSharper的快速文档工具(默认键绑定CTRL+Q)时,它清楚地显示了继承文档的例外情况 所以我想知道。这是ReSharper的问题还是我应该再次声明异常 我的代码分解为重要部分 public interface IMyService { /// <summary>...</summary> /// <exception cref="CantMoveForwardExcept
我的代码分解为重要部分
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)
{
}
}
公共接口IMyService
{
/// ...
///
///如果你回来了。
///
void向前移动();
}
公共类MyService:IMyService
{
公共无效向前移动()
{
}
}
公共密封类CantMoveForwardException:异常
{
公共CantMoveForwardException(字符串消息):基本(消息)
{
}
}
您应该向CantMoveForwardException类添加注释。以下是简单的选项:
/// <inheritdoc/>
public sealed class CantMoveForwardException : Exception
{
/// <inheritdoc/>
public CantMoveForwardException(string message) : base(message)
{
}
}
//
公共密封类CantMoveForwardException:异常
{
///
公共CantMoveForwardException(字符串消息):基本(消息)
{
}
}
CantMoveForwardException类可能没有文档。你的其他评论很好。