ASP.NET Web 应用程序中类及其文件的正确命名约定是什么

Question

你们能告诉我我应该如何在 ASP.NET 程序集中正确命名类及其文件吗？我知道类应该从大写字母开始命名的基本规则，它应该是一个名词。但是，如果我的程序和多个项目中有多个命名空间怎么办？例如，我正在为动物园制作一个程序，我想要描述不同动物的类，并且我有 corpA.zoo 和 corpB.zoo 名称空间，并且在不同的名称空间中具有相同名称但具有不同细节的类。会不会太混乱了？ 我应该按以下方式命名动物的类和文件：1) Donkey.cs 2) Monkey.cs 和 3) Lovebird.cs 吗？这是正确的吗？我明白这取决于托管 Web 服务器的文件系统的功能，但它也应该是合乎逻辑的。

提前致谢！希望你明白我的意思。

Answer 1

命名约定对于创建干净且有组织的代码库至关重要，尤其是涉及具有多个命名空间和项目的大型项目时。以下是在 ASP.NET 中命名类和文件的一些技巧：

• 为每个项目或命名空间使用唯一的前缀以避免命名 冲突。例如，如果您有两个项目名为“corpA”和 “corpB”，您可以在动物类别名称前加上“CA”或“CB” 来区分它们，例如“CAAnimal”和“CBAnimal”。
• 使用准确反映目的的描述性名称和 类的功能。例如，不只是“Donkey.cs”， 考虑使用“MammalDonkey.cs”或“CAWorkingDonkey.cs”来制作 类名更具描述性和信息性。
• 遵循类和文件的标准命名约定。在 C# 中， 类通常使用 PascalCase 命名，其中第一个字母 每个单词的首字母大写。例如，“MammalDonkey”而不是 “哺乳动物驴”。
• 保持文件名和类名一致，以免混淆。例如， 如果您的“corpA”项目中有一个名为“CAAnimal”的类，那么 该文件应命名为“CAAnimal.cs”。
• 避免使用保留关键字作为类名，因为这会导致 编译代码时出现问题。
• 避免在类名中使用缩写词或首字母缩略词，因为它们可能是 对于其他开发人员来说是令人困惑和难以理解的 不熟悉项目或领域。
• 考虑使用名称空间将相关类组合在一起。为了 例如，您可以创建一个“Zoo.Animals”命名空间来包含所有 与动物相关的类，例如“Zoo.Animals.Mammals”和 “动物园.动物.鸟类”.
• 如果您在单个命名空间中有大量类，请考虑 将它们分解为子命名空间以更好地组织和 可读性。
• 对相关实体使用一致的命名约定，例如 类、方法和属性。这有助于使您的代码更 可读且更容易理解。

最后，确保选择的类名能够准确描述类的用途和功能，同时保持简洁易记。

总的来说，重要的是要在描述性命名与简单性和一致性之间取得平衡，以创建干净且易于阅读的代码库。

我建议你也看看一些样板项目： https://aspnetboilerplate.com/