2.1 C#中的注释

为了方便程序的阅读，C#语言允许用户在程序中写上一些说明性的文字，这就是代码的注释，所以不用担心添加了注释会增加程序的负担。试想一下，在奋斗了几个月写出了成千上万行代码后，回头看看自己几个月前写的代码，还有谁记得当时是怎么想的呢？或者看别人写好的程序，也会感到一头雾水。所以大家一定要养成注释代码的好习惯。在C#中，常用的注释有两种：单行注释（行注释）和多行注释（块注释）。

2.1.1 行注释和块注释

对于一段代码，注释有多有少，如果说明性文字较少，可以放在一行当中，就可以使用行注释。行注释使用“//”开头，每一行中“//”后面的文字都被认为是注释。行注释通常用在代码之间或者一行代码后面，用来说明某一块代码的作用，如：

      Console.WriteLine("Hello C#!");        //输出信息

刚才讲的是行注释，现在一起来了解一下块注释。块注释其实就是多行注释，当说明性文字过多时，就需要使用块注释。块注释以“/*”开头和“*/”结尾，在“/*”和“*/”之间的内容都被看做注释。比如在前面有这么一段代码。

      /*我的第一个Windows Console程序
      * 输出My first C# Program
      * 输出I love C#
      */
      namespace ConsoleTest
      {
          class Program
          {
              static void Main(string[] args)
              {
                Console.WriteLine("我的第一个C#程序");        //向控制台输出字符串
                Console.WriteLine("I love C#");             //向控制台输出字符串
              }
          }
      }

这里使用的就是块注释。当用户写出“/*”后按回车键，VS就会自动在下一行的行首生成一个“*”符号，这仅仅是为了美观，对注释本身不会有什么影响。

2.1.2 注释规范

在C#中，注释也是有它自己的规范的，如下所示。

（1）关键性的语句要使用注释，如变量声明、条件判断、循环等。

（2）类名前应使用文档注释，说明类的简单功能和使用方法。

（3）复杂的方法前应使用注释，说明方法的功能、参数的含义、返回值等。