.net class 库中的评论

Question

我正在创建 .NET class 库，对于每个 class 我正在 class 的顶部添加一个文档：

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

现在，当我编译库并将其添加为对我的其他项目的引用时，当我尝试使用它时 class 我没有看到文档，例如在 class 的顶部：

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

我想知道在构建库时是否需要设置一些标志？

Answer 1

您需要在“项目属性”的“生成”选项卡中选中 Generate XML documentation file 复选框。