使用MAML记录扩展方法

时间:2011-09-01 07:54:02

标签: extension-methods maml

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

如果我需要参考扩展方法,我该怎么做呢?

2 个答案:

答案 0 :(得分:1)

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

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

我意识到这只对记录您拥有的类的扩展有帮助。在为外部类创建扩展时,除了在扩展方法摘要中包含blurb之外,没有很多选项可以指示该方法是作为扩展方法

附件是我正在玩的一些文档的屏幕截图,但您可以看到扩展部分:Sandcastle documentation example

答案 1 :(得分:0)

几乎相同 - 记住扩展方法只是静态类中的静态方法。所以,例如,如果你有这样的东西(诚然无用的方法):

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

您的文档如下所示:M:StringExtensions.ToSingleQuotedString(System.String)

希望有所帮助。