C#,如何使重载方法共享<summary>标记</summary>

时间:2013-12-11 00:07:17

标签: c# methods overloading summary xml-documentation

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

/// <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描述应该具有相同的标签描述,尽管参数描述可能会有所不同。

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

1 个答案:

答案 0 :(得分:4)

即使方法名称相同,但它们可以具有不同的实现并且可以执行不同的操作。因此,您需要为每个摘要提供单独的摘要。