关于c＃：解决方案中的文件夹应该与名称空间匹配吗？

Should the folders in a solution match the namespace?

解决方案中的文件夹是否应与名称空间匹配？

在我的一个团队项目中，我们有一个类库，该类库在项目中包含许多子文件夹。

项目名称和命名空间：MyCompany.Project.Section。

在此项目中，有几个与"名称空间"部分匹配的文件夹：

文件夹Vehicles在MyCompany.Project.Section.Vehicles命名空间中具有类
文件夹Clothing在MyCompany.Project.Section.Clothing命名空间中具有类
等等

在同一项目中，是另一个流氓文件夹

文件夹BusinessObjects在MyCompany.Project.Section命名空间中具有类

在某些情况下，为了"组织上的方便"而制作文件夹。

我的问题是：什么标准？在类库中，文件夹通常与名称空间结构匹配还是混在一起？

另外，请注意，如果您使用内置模板将类添加到文件夹，则默认情况下会将其放置在反映文件夹层次结构的命名空间中。

这些类将更容易找到，仅凭其应是足够好的理由。

我们遵循的规则是：

项目/程序集名称与根名称空间相同，除了.dll结尾
上述规则的唯一例外是项目以.Core结尾，.Core被剥离
文件夹等于名称空间
每个文件一种类型(类，结构，枚举，委托等)使查找正确的文件变得容易

没有。

好。

我已经在小型项目和大型项目中尝试了这两种方法，都使用了一个(我)和一个开发人员团队。

好。

我发现最简单和最有效的方法是每个项目有一个名称空间，所有类都进入该名称空间。然后，您可以将类文件放到所需的任何项目文件夹中。始终在文件顶部添加using语句没有任何麻烦，因为只有一个名称空间。

好。

将源文件组织到文件夹中很重要，我认为应使用所有文件夹。不需要这些文件夹也映射到名称空间是不必要的，需要做更多的工作，而我发现这实际上对组织有害，因为增加的负担会导致混乱。

好。

以以下FxCop警告为例：

好。

CA1020: Avoid namespaces with few types
cause: A namespace other than the global namespace contains fewer than five types
https://msdn.microsoft.com/en-gb/library/ms182130.aspx

Ok.

此警告鼓励您将新文件转储到通用的Project.General文件夹中，甚至转储到项目根目录中，直到您有四个类似的类来证明创建新文件夹的合理性为止。那会发生吗？

好。

查找文件

好。

公认的答案是："这些班级将更容易找到，仅凭这些就足够了。"

好。

我怀疑答案是指项目中有多个名称空间，这些名称空间不映射到文件夹结构，而不是我建议的是具有单个名称空间的项目。

好。

在任何情况下，虽然无法从名称空间确定类文件所在的文件夹，都可以使用"转到定义"或Visual Studio中的搜索解决方案资源管理器框找到它。我认为这也不是什么大问题。在寻找文件以证明对其进行优化的问题上，我什至没有花费我的开发时间的0.1％。

好。

名称冲突

好。

确保创建多个名称空间可以使项目具有两个具有相同名称的类。但这真的是一件好事吗？禁止这种可能性可能更容易吗？允许两个具有相同名称的类会创建一个更复杂的情况，其中90％的时间事情以某种方式工作，然后突然发现您有一个特殊情况。假设您在单独的命名空间中定义了两个Rectangle类：

好。

类Project1.Image.Rectangle

类Project1.Window.Rectangle

好。

可能会遇到一个问题，即源文件需要同时包含两个名称空间。现在，您必须在该文件的所有位置写出完整的名称空间：

好。

1	var rectangle = new Project1.Window.Rectangle();

或弄乱一些讨厌的using语句：

好。

1	using Rectangle = Project1.Window.Rectangle;

在项目中只有一个名称空间时，您不得不提出不同的名称，而我想用更具描述性的名称命名，如下所示：

好。

类Project1.ImageRectangle

类Project1.WindowRectangle

好。

而且用法在任何地方都是相同的，当文件同时使用两种类型时，您不必处理特殊情况。

好。

使用语句

好。

1
2
3
4
5
6
7

using Project1.General;
using Project1.Image;
using Project1.Window;
using Project1.Window.Controls;
using Project1.Shapes;
using Project1.Input;
using Project1.Data;

与

好。

1	using Project1;

无需在编写代码时始终添加名称空间的简便性。这不是真正花费的时间，而是必须要做的只是使用大量的using语句填充文件的流程中的中断-为什么？这值得么？

好。

更改项目文件夹结构

好。

如果将文件夹映射到名称空间，则项目文件夹路径会有效地硬编码到每个源文件中。这意味着项目中文件或文件夹的任何重命名或移动都需要更改实际的文件内容。该文件夹中文件的名称空间声明以及在引用该文件夹中的类的其他文件中使用语句。尽管更改本身对工具来说是微不足道的，但通常会导致大型提交，其中包括许多文件甚至其类都没有更改。

好。

使用项目中的单个名称空间，您可以更改项目文件夹的结构，但是无需修改任何源文件本身。

好。

Visual Studio会自动将新文件的名称空间映射到在其中创建的项目文件夹

好。

不幸的是，但我发现更正命名空间的麻烦少于处理它们的麻烦。另外，我已经习惯于复制粘贴现有文件，而不是使用Add-> New。

好。

智能感知和对象浏览器

好。

我认为在大型项目中使用多个名称空间的最大好处是，在查看任何在名称空间层次结构中显示类的工具中查看类时，都具有额外的组织性。甚至文档。显然，在项目中只有一个名称空间会导致所有类都显示在一个列表中，而不是分为几类。但是，就我个人而言，我从来没有因为缺少它而感到困惑或拖延，所以我发现它没有足够大的好处来证明多个名称空间的合理性。

好。

尽管如果我正在编写一个大型的公共类库，那么我可能会在项目中使用多个名称空间，以使程序集在工具和文档中看起来很整洁。

好。

我认为.NET中的标准是尝试在可能的情况下做到这一点，而不是创建不必要的深层结构，而只是作为硬性规则坚持下去。我的项目中没有一个100％的时间遵循命名空间==结构规则，有时它更干净/更好地脱离此类规则。

在Java中，您别无选择。我称这是理论上有效与实践上有效的经典案例。

@lassevk：我同意这些规则，还有一点要补充。

当我有嵌套类时，我仍然将它们拆分出来，每个文件一个。像这样：

1
2
3
4
5

// ----- Foo.cs
partial class Foo
{
// Foo implementation here
}

和

1
2
3
4
5
6
7
8