23

Microsoft Visual Studio 2012 を使用しています。コード例を C# クラス/メソッドの XML コメントに入れると、私のアセンブリを参照するユーザーはそのコード例をどのように見るのでしょうか?

私は自分のアセンブリを参照しようとしましたが、見つけた唯一の方法は、assembly.xml ファイルを調べることでした。これらのコード例を確認するために、Visual Studio またはその他のものを解決できますか?

これが私がコメントに入れたものです:

/// <summary>
/// This is my method example
/// </summary>
/// <example>
/// <code>
/// // Here is my code example. Call my method like this:
/// const int a = 10;
/// MethodExample(a);
/// </code>
/// </example>
public static void MethodExample(int parameter)
{
}

IntelliSense で得られるものは次のとおりです。

ここに画像の説明を入力

オブジェクト ブラウザで取得したものは次のとおりです。

ここに画像の説明を入力

assembly.xml ファイルで得られるものは次のとおりです。

ここに画像の説明を入力

取得したいもの: オブジェクト ブラウザーと IntelliSense のコード例を参照してください。

4

2 に答える 2

7

多くの XML コメント タグは、他のタグの子要素としてのみ IntelliSense に表示されます。ChildCompletionList タグと呼ばれるこれらのタグは、c、code、example、list、listheader、para、paramref、see および see also です。

/// <summary>
/// MethodExample the function that does it all...
/// <example>
/// <code>
/// <para/>// Here is my code example. Call my method like this:
/// <para/>const int a = 10;
/// <para/>MethodExample(a);
/// </code>
/// </example>
/// </summary>
于 2014-10-30T14:43:05.350 に答える