能否在方法XML文档中指定方法触发的事件？

默认的.NET XML文档注释规范里，并没有像<exception>那样专门用于标记方法会触发哪些事件的官方标签。不过你可以用以下几种常用方式来实现类似需求：

• 使用<remarks>标签补充说明：在<remarks>里明确列出方法触发的事件，比如：

  /// <summary>
  /// 执行数据加载操作
  /// </summary>
  /// <remarks>
  /// 此方法完成时会触发以下事件：
  /// - DataLoaded：数据加载完成后触发
  /// - LoadFailed：加载失败时触发
  /// </remarks>
  public void LoadData()
  {
      // 方法实现
  }
  

• 自定义标签：很多团队会约定使用自定义标签（比如<fires>或<raises>）来专门标记触发的事件，虽然官方没有定义，但大部分文档生成工具都能识别这类自定义标签，示例：

  /// <summary>
  /// 启动服务
  /// </summary>
  /// <fires cref="ServiceStarted"/>
  /// <fires cref="ServiceError"/>
  public void StartService()
  {
      // 方法实现
  }
  

• 用<see>标签关联事件：如果只是简单提及，可以在<summary>或<remarks>里用<see>标签直接链接到对应的事件，比如：

  /// <summary>
  /// 触发<see cref="UserLoggedIn"/>事件，通知用户登录状态变更
  /// </summary>
  public void OnUserLoggedIn()
  {
      // 方法实现
  }
  

内容的提问来源于stack exchange，提问作者Eric Bole-Feysot