.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复选框。