【问题标题】:C#, How to make overload methods share <summary> tagC#,如何使重载方法共享 <summary> 标签
【发布时间】:2026-02-02 20:35:02
【问题描述】:

我正在开发一个小类,使用我的重载方法,如下所示:

/// <summary>
/// some description about myMethod
/// </summary>
/// <param name="arg1"></param>
/// <param name="arg2"></param>
/// <returns></returns>
public string myMethod(string arg1, string arg2) { };
public string myMethod(string arg1){};

问题是采用一个参数的方法没有在标签中显示描述。我应该将相同的摘要标签单独添加到第二种方法吗?我觉得有点烦,因为myMethod描述应该有相同的标签描述,虽然参数描述可以不同。

有没有办法让重载方法共享一个描述?

【问题讨论】:

  • AFAIK,你不能。对不起。
  • 这将如何发生?带有 1 个参数的方法的工具提示将显示 3。这只是令人困惑,恐怕您必须复制它。

标签: c# methods overloading summary xml-documentation


【解决方案1】:

尽管方法名称相同,但它们可以有不同的实现,可以做不同的事情。因此,您需要为每个人提供单独的摘要。

【讨论】: