CA1034：嵌套类型不应可见

Question

这里是 我试图理解的规则的解释。以下是代码分析器抱怨的简化代码：

Public Class CustomerSpeed

    Public Enum ProfitTypeEnum As Integer
        NotSpecified = 0
        FlatAmount = 1
        PercentOfProfit = 2
    End Enum

    Private _ProfitTypeEnum As ProfitTypeEnum

    Public Sub New(ByVal profitType As ProfitTypeEnum)

        _ProfitTypeEnum = profitType

    End Sub

End Class

如果枚举仅与类相关，为什么将其设为类中的包含类型是一件坏事？对我来说似乎更简洁...

有人知道下面这行是什么意思吗？：

嵌套类型包括成员可访问性的概念，一些程序员并不清楚

使用命名空间对类和枚举进行分组似乎不是解决此警告的有用方法，因为我希望两个枚举都属于与类名相同的父级别。

Answer 1

除了其他响应中已经涵盖的可用性和可发现性问题之外，还存在潜在的可维护性问题。当您发现您的枚举在其他地方也可能有用时会发生什么？将其移出其父类将是一个重大更改，复制它会引入其自身的可维护性问题，并且要求 API 使用者将其与另一个类一起使用开始变得丑陋。为什么不系统地避免嵌套枚举来避免这些潜在的问题呢？

Answer 2

枚举通常不放置在使用它们的类中，因此人们不习惯指定枚举的位置：

Dim speed As New CustomerSpeed(CustomerSpeed.ProfitTypeEnum.FlatAmount)

将枚举放置在类之外使其更易于使用：

Dim speed As New CustomerSpeed(ProfitTypeEnum.FlatAmount)

枚举仍然包含在与类相同的命名空间中。正如分析解释所指出的，您应该使用命名空间对公共成员进行分组，而不是将它们相互嵌套。

Answer 3

我猜这表明嵌套类型可能与静态变量混淆，因为它们都会出现在“.”之后的智能感知（自动完成）中。

即使你看到.NET的BCL（基类库），所有的枚举，即使它们只在一个类中使用，它们也不是嵌套的，原因是，当你想要比较或实例化时，类名+“。 ” + 枚举名称会令人困惑，如下所示，微软也说它会让人困惑，这是正确的。

-- 示例

class RootClass
{
   enum NestedEnum
   {
      StaticItem = 0     
   }

   static string NestedString = "";
}


RootClass.NestedEnum <-- represents enum,
RootClass.NestedString <-- represents static variable

一个是类型，另一个是变量，大多数 MS Code 分析器警告都是为了更好的设计，但是 @George 有一个很大的例外，如果您不喜欢它，请不要使用它，只需继续并禁用警告即可。您当然可以使用大类名而不是命名空间，这只是您的选择。但良好的编程技能是关于别人如何看待你的代码而不是你喜欢什么！

命名空间是用来组织的，通过组织，我们可以减少打字，这就是用更少的努力做更多的工作。但如果您喜欢输入大名鼎鼎的名字，那么没有人会阻止您。