.NET入门篇 C#代码注释

.NET中有三种注释：

1.单行注释   //

2.多行注释   /*开始   */结束

3.文档注释  在类或方法前面敲  ///

///

///文档注释

///

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace 注释
{
    class Program
    {
        /// <summary>
        /// 这个方法是程序的入口  这里是文档注释
        /// </summary>
        /// <param name="args"></param>
        static void Main(string[] args)
        {
            //这里是单行注释

            //下面定义了一个整型变量num，并赋值  应该在具体的程序中说明这个变量的作用
            int num = 10;


            /*
             * 这里是多行注释
             * 这里是多行注释
             * 这里是多行注释
             */


            SayHello();
        }

        /// <summary>
        /// 这个方法是向屏幕打印“Hello World!”
        /// </summary>
        static void SayHello()
        {
            Console.WriteLine("Hello World!");
        }
    }
}

我们在方法前面加上文档注释，这样我们在调用的时候，vs就会提示我们，这样我们一看就能知道这个方法是做什么。

注释不会被执行，有时候调试代码的时候可以将某些代码暂时注释，可以很快发现问题。

注释是给人看的，应能起到提示解释作用，目的是让自己和别人都能看懂，告诉别人或提醒自己这个变量或这个方法是做什么用的。注释一方面是给别人看，一方面是给自己看，人的记忆没有那么好，总有忘记的时候，如果我们添加了注释，过一些时间，我们再回来看我们自己写的代码的时候，一看注释便很快就能回想起来。所以写好代码注释不仅别人受用，你自己也会受益匪浅。

有时候看一个程序员水平的高低，看他的注释就能看出来。平时养成写注释的习惯对程序员来说是非常重要的。