extension-methods - 使用 MAML 记录扩展方法

Question

当我在我的文档中引用一个方法时，我会这样写：M:MyClass.MyMethod(System.String)

如果我需要引用扩展方法，我该怎么做？

Answer 1

我相信 mjd79 是正确的，因为您可以使用与普通方法相同的语法来引用或链接到扩展方法。

不确定您使用什么工具来编译文档，但 Sandcastle 帮助文件生成器会在编译时为任何具有可用扩展方法的类自动查找并生成“扩展”部分。

我意识到这仅有助于记录您拥有的类的扩展。在为外部类创建扩展时，除了在扩展方法摘要中包含一个说明以表明该方法旨在作为扩展方法之外，您没有太多选择

附件是我正在玩的一些文档的屏幕截图，但你可以看到扩展部分：

Answer 2

Pretty much the same way - remember that extension methods are just static methods in a static class. So, for example, if you have something like this (admittedly useless method):

public class StringExtensions
{
  public static string ToSingleQuotedString(this string s)
  {
    return String.Format("'{0}'", s);
  }
}

Your documentation would look like this: M:StringExtensions.ToSingleQuotedString(System.String)

Hope that helps.