从异常实例化中排除 FxCop DoNotPassLiteralsAsLocalizedParameters 违规或本地化异常消息

Question

我在下面的方法代码中得到了两个异常抛出行的 DoNotPassLiteralsAsLocalizedParameters FxCop 违规：

public bool IsPageAccessible(string url, string documentId) {
    if (url == null) {
        throw new ArgumentNullException("url", @"url must not be null, use string.Empty if you don't care what the url is.");
    }

    if (documentId == null) {
        throw new ArgumentNullException("documentId", "documentId must not be null, use string.Empty if you don't care what the documentId is.");
    }
    return true;
}

这意味着：

fxcop 全球化#CA1303 字符串 嵌入源中的文字 代码很难本地化。避免 将字符串文字作为参数传递 在本地化的情况下 通常需要字符串。最多 本地化应用程序，例如 应该本地化字符串参数 被传递给异常构造函数。 创建异常实例时， 因此，检索到一个字符串参数 来自字符串表的更多 比字符串文字更合适。

推理：

我不想本地化异常消息。只用英语就可以了。尽管我们正在构建 API，但所有开发人员都懂英语。并且异常消息无论如何都不应该向生产服务器上的访问者显示。

问题：

• 您不同意我关于异常消息本地化的推理吗？为什么？
• 有没有办法仅从所有异常实例化中排除此 FxCop 警告？我们确实本地化了 API 的其他部分。这些部分将包含最终用户可见的文本。因此，在这些情况下，我们可以通过保留警告来获得价值。
• 你认为我应该如何处理这件事？

Answer 1

我认为你的推理很好，我讨厌当我在 Visual Studio 中本地化异常并且无法找到帮助时，因为编程的通用语言是英语。

更一般地说，您不应该尝试遵守所有 fxcop 规则，这很快就会成为一种负担。最好专注于规则的子集。

我不认为您可以排除特定异常中的警告，但您可以使用 SuppressMessage 属性排除检测：

[SuppressMessage("Microsoft.Globalization", 
                 "CA1303:DoNotPassLiteralsAsLocalizedParameters", 
                 Justification="Exception are not localized")]
public bool IsPageAccessible(string url, string documentId) {
  if (url == null) {
    throw new ArgumentNullException("url", @"url must not be null, use string.Empty if you don't care what the url is.");
  }

  if (documentId == null) {
    throw new ArgumentNullException("documentId", "documentId must not be null, use string.Empty if you don't care what the documentId is.");
  }
  return true;
}

另一种方法是编写 自定义 fxcop 规则 添加此行为。