.net類庫中的注釋

Question

我正在創建.NET類庫，對於每個類，我在類的頂部添加了一個文檔：

/// <summary>
///     Contains helper functions for ...
/// </summary>
public static class MyHelperClass
{
      /// <summary>
      ///     Helper function for ...
      /// </summary>
      public static void HelperFunction() {}
}

現在，當我編譯該庫並將其添加為對其他項目的引用時，當我嘗試使用此類時，在該類的頂部看不到文檔：

MyHelperClass.HelperFunction(); -> Intellisense won't show up my comments

我想知道在構建庫時是否需要設置一些標志？

Answer 1

您需要在“項目屬性”的“構建”選項卡中選中“ Generate XML documentation file復選框。