对委托声明事件的 XML 注释

Question

我正在访问一些旧代码，并且有相当多的事件是用委托手动声明的，而不是使用 EventHandler，如下所示：

/// <summary>
/// Delegate for event Added
/// </summary>
/// <param name="index">Index of the item</param>
/// <param name="item">The item itself</param>
public delegate void ItemAdded(int index, T item);

/// <summary>
/// Added is raised whenever an item is added to the collection
/// </summary>
public event ItemAdded Added;

一切都很好，直到我开始使用 sandcastle 来记录库，因为它可以'找不到由事件声明生成的私有“已添加”字段的任何 XML 注释。我想尝试解决这个问题，但我想做的是：

• 让 sandcastle 忽略自动生成的私有字段，而不告诉它完全忽略所有私有字段，

或者

• 获取为私有字段生成的 XML 注释

是否有无需重构代码即可实现此目的的方法如下：

/// <summary>
/// Delegate for event <see cref="Added"/>
/// </summary>
/// <param name="index">Index of the item</param>
/// <param name="item">The item itself</param>
public delegate void ItemAdded(int index, T item);

/// <summary>
/// Private storage for the event firing delegate for the <see cref="Added"/> event
/// </summary>
private ItemAdded _added;

/// <summary>
/// Added is raised whenever an item is added to the collection
/// </summary>
public event ItemAdded Added
{
    add
    {
        _added += value;
    }
    remove
    {
        _added -= value;
    }
}

Answer 1

虽然不是最理想的，但我找到了解决这个问题的方法，即手动将 XML 注释放入包含项目命名空间级文档的文件中，大致如下：

<member name="F:myCompany.Common.Collections.Generic.EventableCollection`1.Added">
  <summary>
    Auto-generated backing field for the <see cref="E:myCompany.Common.Collections.Generic.EventableSortedList`1.Added">Added</see> event
  </summary>
</member>

这样就大致给出了我所需要的内容。