C＃文件可以包含文件級摘要注釋嗎？

Question

例如

Foo.cs：

using System;

/// <summary>
/// This file contains Foo and Bar-related things.
/// </summary>

namespace Xyz {


class FooThing {
}

}

C＃是否支持這樣的XMLDoc注釋？

Answer 1

不，XML文檔注釋只能出現在特定類型的元素上，如本文所述 ：

在源代碼文件中，可以處理以下文檔注釋並將其添加到XML文件中：

這種用戶定義的類型如類，委托或接口

諸如場，事件，財產或方法之類的成員

如果在文件中放置文件級XMLDoc樣式的注釋，它將附加到下一個類或恰好出現的其他元素。 某些文檔工具（如Sandcastle）提供了添加命名空間級XMLDoc注釋的方法，但它們通常顯示在單獨的文件中。

當然，您可以在每個文件中使用非 XMLDoc樣式的注釋，例如版權標題或類似注釋，只需使用標准的/ * * /樣式注釋塊。

Answer 2

根據/ doc文檔 ，不，這是不受支持的。

在源代碼文件中，可以處理以下文檔注釋並將其添加到XML文件中：

• 這種用戶定義的類型如類，委托或接口

• 諸如場，事件，財產或方法之類的成員

Answer 3

是的你可以。 我認為這個鏈接可以幫助：

C＃記錄和評論

C＃和Visual Studio .NET（VS.NET）使我們能夠在同一個文件中維護代碼和文檔。 VS.NET通過從代碼中獲取特殊標記和結構化的注釋並將它們構建為XML文件來實現此目的。 然后，可以使用此XML文件以各種形式生成人類可讀的文檔，包括網頁，MSDN樣式文檔和代碼窗口中的Intellisense。

在鏈接中，您可以找到有關如何執行此操作的詳細信息...