使用类来组织代码？

Question

目前我的 Form1 代码非常繁重，主要充满了菜单和控件事件。我想做的一件事是以某种方式组织它，这样我就可以展开或折叠“相关代码”（在 Visual Studio 中）。

我的第一次尝试是将与主菜单相关的代码放在一个名为“MainMenu”的嵌套类中，该类位于 Form1 类中，这样当我不需要它时，我可以简单地折叠该嵌套类。这导致了各种各样的问题（即我找不到在这个嵌套类中设置主菜单的方法）。

我缺少一个更简单的解决方案吗？或者有人可以解释一下为什么我的嵌套类想法是错误的？

Answer 1

虽然@testalino的答案确实满足了您的要求，但我想说您的真正问题可能与代码设计有关。很可能表单类包含的代码比应有的多，并且其中一些代码应该移至其他类中。

如果以一种好的方式完成，这可能会给您带来一些好处：

• 当各种函数对通过参数传递给方法的数据进行操作并返回值而不是直接在中获取和设置值时，您可能会获得更多封装（并且耦合更少）的行为。用户界面控件。
• 您可能会获得更可测试的代码库（您确实有单元测试，对吧？）。
• 由于代码分布在多个不同的代码文件中，因此多个人可以更轻松地协作编写代码。这减少了合并冲突（您确实有源代码控制系统，对吧？）。如果你独自做某件事，这一点可能不太适用，但无论如何，养成这个习惯也没什么坏处。

Answer 2

您可以使用#region 和#endregion 来组织类中的代码。然后这些区域是可折叠的。

Answer 3

我建议您使用用户控件来封装一些表单的行为。我想，这是目前您可以使用的最简单的解决方案。您只需选择一些用户界面并将其提取到用户控件并定义一些可从表单访问的公共属性。

将所有处理程序保留在 Form.cs 中是一种非常糟糕的做法。你必须避免它，因为它是不可维护的（我见过很多这样的代码，并且在后期阶段，添加或更改功能被证明在不破坏任何内容的情况下是不可能的，更不用说在不影响应用程序工作方式的情况下更改 UI 了）。

将来，您可能想要尝试不同的方法将 UI 与应用程序逻辑分离，例如探索 MVP/MVC 模式。

Answer 4

如果您的表单变得如此庞大和复杂，以至于您突然希望以某种方式组织它，则强烈暗示需要重构，这将提高代码的可读性、可测试性和可维护性。您实际重构的方式取决于您的实际代码。

它是一个有很多控件的表单吗？考虑将其拆分为单独的用户控件，其中每个控件都显示域数据的某个方面。您是否有很多交互逻辑，对很多事件做出反应？也许引入某种控制器或事件聚合器。

有许多众所周知的模式可以帮助您组织 UI 和域代码。 本系列 讨论的正是这一点，并向您介绍 MVC、MVP、EventAggregator 等模式。它根据您的需要讨论了 Windows 窗体上下文中的模式。

Answer 5

使用partial class 关键字将您的类拆分为多个文件。

Answer 6

我同意其他答案所说的关于在 #regions 中将类似的事件处理程序分组在一起是可靠的，因为考虑到大量的事件。此外，如果处理程序中的代码本身也很庞大，您可能需要考虑将它们重构为逻辑业务逻辑类。示例：

之前的伪代码：

private void SomeButton_Click(...)
{
    using (FileStream fs = ...)
    {
        fs.Write(some form data);
        fs.Write(some more form data);
    }

    DoMoreBusinessLogicStuff();
    ...
    // lots more stuff
    ...
}

之后的伪代码：

private void SomeButton_Click(...)
{
    IBusinessObject obj = new BusinessObject(injectable form data);

    using (IPersistence store = new FilePersistence(...))
    {
        obj.Persist(store);
    }

    obj.DoBusinessRules();
}

这应该将业务、持久性和支持逻辑移动到它们自己的类中，并将事件处理程序保留为仅设计用于收集 UI 输入并将其传递的轻量级 shell。

Answer 7

嵌套类通常不受欢迎，因为它只是对上帝类的轻微升级，而且封装和代码重用也相当模糊。

您应该致力于将您实际拥有的对象表达为代码中的单独业务类：一个类，一个文件。您不这样做有什么特别的原因吗？

Answer 8

根据它正在执行的代码类型，将取决于您可以将其移动到哪里。

如果它处理数据代码，那么您可以将其移到不同名称空间中的单独类中，将处理后的数据返回到控件以允许数据绑定等。

如果 Form1 的代码变得非常繁重，那么这是因为您有太多的工作要做在 Form1 中？你能把它分解成另一种/新的形式吗？

Answer 9

您可以使用可折叠的摘要，但我认为这更多的是为了向其他开发人员提供信息，但始终是良好的做法！

在 VB 中：

''' <summary>
''' 
''' </summary>
''' <remarks></remarks>

在 C# 中

/// <summary>
///
/// </summary>
/// <remarks></remarks>