.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项目属性"中"构建"选项卡中的复选框.