.NET入門(mén)篇 C#代碼注釋

.NET中有三種注釋?zhuān)?/p>

1.單行注釋   //

2.多行注釋   /*開(kāi)始   */結(jié)束

3.文檔注釋  在類(lèi)或方法前面敲  ///

///

///文檔注釋

///

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

namespace 注釋
{
    class Program
    {
        /// <summary>
        /// 這個(gè)方法是程序的入口  這里是文檔注釋
        /// </summary>
        /// <param name="args"></param>
        static void Main(string[] args)
        {
            //這里是單行注釋

            //下面定義了一個(gè)整型變量num，并賦值  應(yīng)該在具體的程序中說(shuō)明這個(gè)變量的作用
            int num = 10;


            /*
             * 這里是多行注釋
             * 這里是多行注釋
             * 這里是多行注釋
             */


            SayHello();
        }

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

我們?cè)诜椒ㄇ懊婕由衔臋n注釋?zhuān)@樣我們?cè)谡{(diào)用的時(shí)候，vs就會(huì)提示我們，這樣我們一看就能知道這個(gè)方法是做什么。

注釋不會(huì)被執(zhí)行，有時(shí)候調(diào)試代碼的時(shí)候可以將某些代碼暫時(shí)注釋?zhuān)梢院芸彀l(fā)現(xiàn)問(wèn)題。

注釋是給人看的，應(yīng)能起到提示解釋作用，目的是讓自己和別人都能看懂，告訴別人或提醒自己這個(gè)變量或這個(gè)方法是做什么用的。注釋一方面是給別人看，一方面是給自己看，人的記憶沒(méi)有那么好，總有忘記的時(shí)候，如果我們添加了注釋?zhuān)^(guò)一些時(shí)間，我們?cè)倩貋?lái)看我們自己寫(xiě)的代碼的時(shí)候，一看注釋便很快就能回想起來(lái)。所以寫(xiě)好代碼注釋不僅別人受用，你自己也會(huì)受益匪淺。

有時(shí)候看一個(gè)程序員水平的高低，看他的注釋就能看出來(lái)。平時(shí)養(yǎng)成寫(xiě)注釋的習(xí)慣對(duì)程序員來(lái)說(shuō)是非常重要的。