跳到主要内容

C# 注释

提示
  1. 注释的种类：C# 中有三种类型的注释：单行注释（//），多行注释（/* */），和 XML 文档注释（///），用于不同的注释需求。
  2. 注释的用途：注释是为了帮助理解代码的文字说明，它们不被编译器执行，且在单行或多行中对代码的功能、目的进行描述。
  3. 注释的正确使用：注释应该用于解释复杂逻辑或提供重要信息，而避免对明显代码的冗余说明，以保持代码清晰和可维护。

[注释用于程序中，以帮助我们理解代码片段。它们是供人阅读的文字，旨在使代码易读。编译器完全忽略注释。

在 C# 中，有 3 种类型的注释：

  1. 单行注释（//）
  2. 多行注释（/* */）
  3. XML 注释（///）

单行注释​

单行注释以双斜杠 // 开始。编译器会忽略 // 后面直到行尾的所有内容。例如，

int a = 5 + 7; // 加 5 和 7

这里，加 5 和 7 是注释。

示例 1：使用单行注释​

// Hello World 程序
using System;

namespace HelloWorld
{
	class Program
	{
		public static void Main(string[] args)  // 从 Main 方法开始执行
		{
			// 打印 Hello World
			Console.WriteLine("Hello World!");
		}
	}
}

上述程序包含 3 条单行注释：

// Hello World 程序
// 从 Main 方法开始执行

和

// 打印 Hello World

单行注释可以单独写在一行，也可以与代码写在同一行。然而，建议在单独的一行使用注释。

多行注释​

多行注释以 /* 开始，并以 */ 结束。多行注释可以跨越多行。

示例 2：使用多行注释​

/*
	这是一个 C# 中的 Hello World 程序。
	此程序打印 Hello World。
*/
using System;

namespace HelloWorld
{
	class Program
	{
		public static void Main(string[] args)
		{
			/* 打印 Hello World     */
			Console.WriteLine("Hello World!");
		}
	}
}

上述程序包含 2 条多行注释：

/*
这是一个 C# 中的 Hello World 程序。
此程序打印 Hello World。
*/

和

/* 打印 Hello World */

在这里，我们可能已经注意到，多行注释并不一定要跨越多行。/* … */ 可以代替单行注释使用。

XML 文档注释​

XML 文档注释是 C# 中的一个特殊功能。它以三个斜杠 /// 开始，用于对代码片段进行分类描述。这是通过注释中的 XML 标签来完成的。这些注释随后用于创建单独的 XML 文档文件。

如果你不熟悉 XML，可以查看 什么是 XML?

示例 3：使用 XML 文档注释​

/// <summary>
///  这是一个 hello world 程序。
/// </summary>

using System;

namespace HelloWorld
{
	class Program
	{
		public static void Main(string[] args)
		{
			Console.WriteLine("Hello World!");
		}
	}
}

上述程序中使用的 XML 注释是

/// <summary>
/// 这是一个 hello world 程序。
/// </summary>

生成的 XML 文档（.xml 文件）将包含：

<?xml version="1.0"?>
<doc>
	<assembly>
		<name>HelloWorld</name>
	</assembly>
	<members>
	</members>
</doc>

如果你对学习更多内容感兴趣，可以访问 XML 文档注释。

正确使用注释​

注释用于解释代码的部分，但不应过度使用。

例如：

// 打印 Hello World
Console.WriteLine("Hello World");

在上面的示例中，使用注释是不必要的。很明显，该行

将打印 Hello World。在这种情况下应避免使用注释。

  • 注释应在程序中用于解释复杂的算法和技巧。
  • 注释应简短并直接，而不是长篇大论。
  • 作为一个经验法则，最好使用注释来解释为什么而不是如何。
最后于 更新