作爲程序開發者,編寫代碼不僅要自己能夠看懂,小組成員和其他人員也要看明白。如果不對代碼添加說明信息,也許我們自己過一段時間後都不明白自己當時編寫的是什麼,這是一件很糟糕的事。爲了避免這種情況,程序員的一個非常重要的工作就是給程序添加說明信息,也就是註釋。
C#提供了多種註釋類型:
單行文本註釋:
在程序中"//"描述一個單行的文本註釋,我們一般寫在語句後部或上部。
//單行文本註釋
多行文本註釋:
在程序中"/* ---------*/ "這樣描述一個多行文註釋。
/*
一場地震,生死兩難;
只道三四險,不知五月難;
縱有六雙眼,淚也流不完;
七顆心兒懸,零八奧運艱;
高呼九洲十地華人現,縱使百舸千帆風浪間,也讓咱行得萬年船!
*/
XML文檔註釋:
XML文檔註釋一般都寫在方法或類的上部,在VS中,只需要連續輸入三個"///"就可以自動生成一段XML文檔註釋,格式如下:
/// <summary>
/// 這是一個Main方法,是C#應用程序的入口.程序控制在該方法中開始和結束.
/// </summary>
/// <param name="args"></param>
static void Main(string[] args)
{
}
說明:其中 summary是對這個方法或類的說明,摘要<param name="args"></param>是指方法的當前有一個參數。
添加註釋行的代碼Program.cs:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
namespace HelloWorld{
///<summary>
///這是第一個控制檯應用程序,實現簡單輸出功能
///<summary>
class Program{
static void Main(string[] args) //這是程序入口點
{
/*
這是添加的關鍵代碼
*/
Console.WriteLine("HelloWorld"); //向控制檯輸出HelloWorld
Console.ReadLine();
}
}
}
當在一個方法前面輸出“///”時,會自動產生文檔註釋,這種註釋可導出成XML文檔