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

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

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

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