C＃ 注释

Question

在本文中，我们将学习 C＃注释，不同样式的注释，以及为什么以及如何在程序中使用它们。

程序中使用注释来帮助我们理解一段代码。它们是人类可读的词，旨在使代码可读。注释被编译器完全忽略。

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

1. 单行注释( // )
2. 多行注释( /* */ )
3. XML 注释( /// )

---

单行注释

单行注释以双斜杠 // 开头。编译器将忽略 // 至行尾的所有内容。例如，

int a = 5 + 7; // Adding 5 and 7

在这里， Adding 5 and 7 是注释。

示例 1：使用单行注释

// Hello World Program
using System;

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

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

// Hello World Program
// Execution Starts from Main method

和

// Prints Hello World

单行注释可以写在单独的行中，也可以与代码一起写在同一行中。但是，建议在单独的行中使用注释。

---

多行注释

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

示例 2：使用多行注释

/*
    This is a Hello World Program in C#.
    This program prints Hello World.
*/
using System;

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

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

/*
This is a Hello World Program in C#.
This program prints Hello World.
*/

和

/* Prints Hello World */

在这里，我们可能已经注意到，多行注释不必跨越多行。 /* … */ 可以代替单行注释。

---

XML 文档注释

XML 文档注释是 C＃的一项特殊功能。它以三斜杠 /// 开头，用于分类地描述一段代码。这通过在注释中使用 XML 标记来完成。这些注释然后用于创建单独的 XML 文档文件。

如果您不熟悉 XML，请参阅什么是 XML？

示例 3：使用 XML 文档注释

///
///  This is a hello world program.
/// 

using System;

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

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

///
/// This is a hello world program.
/// 

生成的 XML 文档(.xml 文件) 将包含：

    
        HelloWorld
    
    
    

如果您有兴趣了解更多信息，请访问 XML 文档注释。

---

正确使用注释

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

例如：

// Prints Hello World
Console.WriteLine("Hello World");

在上面的示例中不必使用注释。很明显，该行将打印 Hello World。在这种情况下，应避免发表评论。

• 相反，应在程序中使用注释来解释复杂的算法和技术。
• 评论应简短，切题而不是冗长的描述。
• 作为一个经验法则，最好是使用注释来解释 为什么 ，而不是 如何 。