提供 XML 程式碼註解

程式碼註解是指放置在原始程式碼 (Source Code) 之中的註解,這些註解可以透過 IntelliSense 功能提供給整合式開發環境 (IDE) 的使用者使用。

[Visual Basic]

在 Visual Basic 中是透過 ''' (三個單引號) 分隔符號來使用 XML 程式碼註解。 如需詳細資訊,請參閱 HOW TO:在 Visual Basic 中建立 XML 文件

[C#, J#]

您可以使用 XML 文件功能註解程式碼。 當您以 XML 文件註解為方案中原始程式檔 (Source File) 所定義的型別和成員進行附註時,這些註解將會透過 IntelliSense 功能顯示,例如:

注意事項注意事項

將部分方法標記為註解時,只有放置在實作 (而非定義) 中的註解才會出現在 IntelliSense 功能中。

如需詳細資訊,請參閱XML 文件註解 (C# 程式設計手冊)

[C++]

根據預設,原始程式碼中使用 // 或 /* 分隔符號的任何註解都會在成員清單中其相關成員旁邊顯示。 如需詳細資訊,請參閱 C++ CommentsXML Documentation (Visual C++)

捲動清單時,IntelliSense 會在反白顯示成員旁邊的快顯視窗中,顯示最多 12 行的註解。 一個函式有多個註解時,IntelliSense 會根據其在程式碼中出現的位置,決定成員清單中要顯示的註解:

  1. IntelliSense 會先顯示宣告中行結尾的註解。 例如:

    void MyFunction();   //EOL declaration comments
    
  2. 如果 IntelliSense 找不到前一種註解,將會直接顯示在宣告前面,中間沒有空白行的註解。 例如:

    //Before declaration comments
       void MyFunction();
    
  3. 如果在程式碼中找不到前兩種註解,IntelliSense 會顯示定義中行結尾的註解。 例如:

    int CMyAppDoc::MyVariable=2; // EOL definition comments
    
  4. 最後,如果程式碼中並未出現任一種註解,則 IntelliSense 會顯示直接出現在定義前面,而之間沒有空白行的註解。 例如:

    //Before definition comments
    CMyAppDoc::MyFunction() 
    {
       return; 
    }
    

請參閱

參考

列出成員

其他資源

使用 IntelliSense