用于通知方法调用者该方法抛出的异常类型的属性

Question

我不打算实现 Java“throws”关键字。请参阅http://www.artima.com/intv/handcuffsP.html，讨论 throws 关键字的优点以及为什么它没有在 C# 中实现。

不过，我很好奇是否有办法创建如下所示的属性：

[ThrowsException( exceptionType = NullReferenceException )] 
[ThrowsException( exceptionType = AuthenticationException )]
public void Login( Credentials credz ) 
{
    // ... etc...
}

这样 - 当调用一个使用一个或多个 ThrowsException 属性修饰的方法时，该方法抛出的异常类型（至少是由 ThrowsException 属性显式声明的异常类型）将在方法的文档中可见

这与 Java 的“throws”关键字不同，因为它不需要调用者处理这些异常。这样做可能会引入重大更改，例如在不处理版本更改引入的新异常的客户端应用程序中。

虽然可以使用：

/// <exception cref="member">description</exception>

我使用属性的意图是，如果异常名称已更改或异常不再存在，则项目不会编译。所以How To Document Thrown Exceptions，不是同一个问题。

---

更新：2013-05-23

我想出了一种通过使用属性而不使用插件来解决的方法。我将在本周末尝试解决它，如果它按预期工作，我很乐意发布解决方案。如果有人击败我发布解决方案，我会很乐意接受他们的回答。

由于我要到星期一才能解决这个问题，如果你能打败我，我会提供赏金 - 一个可以接受的答案是：

• （不包括使用 Visual Studio 插件或任何第三方工具
• && 提供了一种在 XML 文档中包含异常的方法
• && 确保在编译期间强制执行类型安全）
• ||证明不可能满足上述三个要求才能解决此问题中提出的问题

我认为 XML 文档不反映异常是可以接受的，从 ThrowsException 属性开始，直到项目构建完成。

看到基于 Resharper 的解决方案会很有趣（因为它在我工作过的大多数开发商店中都很常见），但如果存在与第三方工具无关的解决方案，它将不会被接受.同样，仅适用于 Visual Studio 的解决方案将被接受，而不是依赖于 Resharper 的解决方案，但如果存在适用于其他 IDE 的解决方案，则不会被接受，例如MonoDevelop（支持更多框架——甚至更好）。

Answer 1

以下应该可以工作

[ThrowsException( ExceptionType = typeof(NullReferenceException) )]

您的属性将具有Type 类型的属性

Type ExceptionType { get; set; }

Answer 2

在 C# 中，您使用 XML 文档记录类及其成员。在 Visual Studio 中，开始在某些内容上输入斜杠，到第三个斜杠时，它会自动生成最常见的标签供您填写。它看起来有点像 Javadoc 和 JSDoc。

您正在寻找，特别是this tag。

Answer 3

我使用属性的意图是使项目无法编译 如果异常名称已更改或异常没有 不再存在。因此，如何记录抛出的异常不是 同样的问题。

您可以在不使用属性的情况下执行此操作，而是通过编写 <exception> 文档并像这样配置您的项目：

Project properties -> 'Build' tab:
'Output' section: Check 'XML documentation file'.
'Treat warnings as erros' section: Check 'Specific warnings' and add warning 1574.

如果无法解析 XML 文档 cref 属性值，则项目将无法编译。