核心 C-Sharp -命名空间 & 注释

2.5 命名空间

在 C# 中，命名空间（Namespace）是一种组织和管理代码的机制，用于防止命名冲突并提高代码的可维护性。以下是命名空间的主要作用和功能：

1. 组织代码： 命名空间可以帮助开发者组织代码，将相关的类、接口、结构体等组织在一起，使代码结构更加清晰和有序。
2. 避免命名冲突： 命名空间提供了一个封装的容器，其中的类型（类、结构体、接口等）可以拥有相同的名称，只要它们位于不同的命名空间中。这有助于防止在大型项目中出现命名冲突。
3. 提供全局唯一标识符： 命名空间可以为类型提供一个全局唯一的标识符，这使得在大型项目中更容易理解和查找特定类型。
4. 模块化开发： 命名空间支持模块化开发，允许不同的团队或开发者独立地开发和维护特定命名空间下的代码，从而提高项目的可维护性。
5. 提高可读性： 使用命名空间可以使代码更易读，开发者可以通过命名空间结构快速了解代码的层次结构和组织方式。
   以下是一个简单的例子，展示了如何在 C# 中使用命名空间 ：

// 定义一个命名空间
namespace MyProject.Utilities
{
    // 定义一个类
    public class Helper
    {
        public void DoSomething()
        {
            // 实现具体的功能
        }
    }
}

// 在另一个文件或项目中使用命名空间中的类
namespace AnotherNamespace
{
    class Program
    {
        static void Main()
        {
            // 使用命名空间中的类
            MyProject.Utilities.Helper helper = new MyProject.Utilities.Helper();
            helper.DoSomething();
        }
    }
}

在这个例子中，MyProject.Utilities 是一个命名空间，Helper 类位于这个命名空间中。在另一个命名空间 AnotherNamespace 中，我们可以通过引用完整的命名空间路径来使用 Helper 类。

2.6 注释

在 C #中 ，有三种主要的注释方法，用于向代码中添加注释以提供说明和文档。这三种注释方法分别是单行注释、多行注释和 XML 注释。

1. 单行注释：
   单行注释使用 // 符号，可以在一行代码的末尾添加注释。

// 这是一个单行注释
int x = 10; // 这是另一个单行注释

2. 多行注释：
   多行注释使用 /* 开始，*/ 结束，可以跨越多行。

/*
  这是一个多行注释
  可以在多行中添加注释
*/
int y = 20;

3. XML 注释：
   XML 注释是一种特殊的注释形式，用于生成文档。它以 /// 开始，通常用于类、方法、属性等的说明。

/// <summary>
/// 这是一个XML注释，用于描述方法的作用。
/// </summary>
/// <param name="a">第一个参数</param>
/// <param name="b">第二个参数</param>
/// <returns>返回值</returns>
int Add(int a, int b)
{
    return a + b;
}

XML 注释包含一些特殊的标签，如 <summary> 用于提供摘要说明， <param> 用于描述方法参数， <returns> 用于描述返回值。这些 XML 注释可以被工具用于生成代码文档（如 XML 文档）。