.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就會提示我們，這樣我們一看就能知道這個方法是做什么。

注釋不會被執行，有時候調試代碼的時候可以將某些代碼暫時注釋，可以很快發現問題。

注釋是給人看的，應能起到提示解釋作用，目的是讓自己和別人都能看懂，告訴別人或提醒自己這個變量或這個方法是做什么用的。注釋一方面是給別人看，一方面是給自己看，人的記憶沒有那么好，總有忘記的時候，如果我們添加了注釋，過一些時間，我們再回來看我們自己寫的代碼的時候，一看注釋便很快就能回想起來。所以寫好代碼注釋不僅別人受用，你自己也會受益匪淺。

有時候看一個程序員水平的高低，看他的注釋就能看出來。平時養成寫注釋的習慣對程序員來說是非常重要的。