extension-methods - MAMLを使用した拡張メソッドの文書化

Question

ドキュメントでメソッドを参照するときは、次のように記述します。M：MyClass.MyMethod（System.String）

拡張メソッドを参照する必要がある場合、どうすれば同じことができますか？

score 1 · Accepted Answer

mjd79は、通常のメソッドと同じ構文を使用して拡張メソッドを参照またはリンクするという点で正しいと思います。

ドキュメントのコンパイルに使用しているツールはわかりませんが、Sandcastle Help File Builderは、コンパイル時に使用可能な拡張メソッドを持つクラスの「拡張」セクションを自動的に検出して生成します。

これは、所有しているクラスの拡張機能を文書化する場合にのみ役立つことを理解しています。外部クラスの拡張機能を作成する場合、メソッドが拡張メソッドとして意図されていることを示すために、拡張メソッドの概要に宣伝文句を含める以外に多くのオプションはありません。

添付されているのは、私が遊んでいたいくつかのドキュメントのスクリーンショットですが、拡張機能のセクションを見ることができます。サンドキャッスルのドキュメント例

score 0 · Accepted Answer

ほぼ同じ方法です。拡張メソッドは静的クラスの静的メソッドにすぎないことに注意してください。したがって、たとえば、次のようなものがある場合（明らかに役に立たない方法）：

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

ドキュメントは次のようになります。M:StringExtensions.ToSingleQuotedString(System.String)

お役に立てば幸いです。

2 に答える 2