[英]Difference between // and /// in c#
當我輸入///
,Visual Studio 會向我顯示一些如下參數:
/// <summary>
///
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
C# 中的//
和///
什么區別?
有很大的不同。
第一:XML 注釋將顯示在工具提示和自動完成上。 嘗試編寫 XML 注釋,並在編寫函數時注意在鍵入函數時在 XML 注釋中所寫的內容如何彈出。
第二:可以輕松地使用工具生成完整的文檔。
它們都是不會被編譯的注釋。 當您在 Visual Studio 中鍵入 /// 時,它會為您生成這些注釋。 您可以將這些 XML 注釋用作文檔。
在第一個//
之后鍵入的任何內容都被視為注釋(不是編譯代碼)。 您的 IDE(即 Visual Studio)使用這些特殊的 XML 注釋來執行諸如通過 Intellisense 顯示有關方法/類型/等的詳細信息的操作。
// 注釋是普通注釋,而 /// 注釋通常稱為 xml 注釋。 它們可用於為您的課程制作詳細的幫助文檔。
當您使用 /// 時,它將根據函數頭生成注釋(如您在示例中所見),然后在您在其他地方使用該函數時可以引用這些注釋。 例如,如果我有以下內容:
///<summary>
///Does cool things
///</summary>
///<param name="x">A cool number</param>
//There's another for return, I don't remember the exact format:
///<return>A frigid number</return>
int function(int x)
如果我要在其他地方寫這個:
int a = function(b);
我可以將鼠標放在“函數”上,然后會彈出一個小窗口,其中有一個總結,說明它做了很酷的事情,並解釋說它需要一個很酷的數字並返回一個寒冷的數字。 這也適用於重載,因此您可以滾動瀏覽每個重載標題並在所有標題上放置不同的摘要/變量解釋。
單行注釋 (//):
示例:
main()
{
cout<<"Hello world"; //'cout' is used for printing the output, it prints Hello world
}
在上面的例子中,用//注釋,描述了'cout'語句的使用。
XML 文檔注釋 (///):
示例:
///<summary>
/// Example 1
/// Using <summary> rag
///</summary>
有關詳細信息,請訪問以下鏈接:
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.