8

使用方法の簡単な例を作成したいクラスがあります。ただし、クラス宣言でタグを使用すると、Sandcastle の出力に例が表示されません。オブジェクトのメンバーには問題なく機能しますが、クラス自体には機能しません。サンドキャッスルはこれを処理できますか?

私がやりたいことの例は次のとおりです。

MSDN TcpClient ドキュメント

これには、クラスの使用方法の例があります。クラスにそのようなものを含めるにはどうすればよいですか？

これは私がやりたいことです：

/// <summary> My example class </summary>
/// <example>
///   <code>
///      // Example code on how to use the class
///   </code>
/// </example>
public class MyClass
{
    public string MyString {get;set;}
}
4

2 に答える 2

1

Sandcastle の場合、独自のタグ変換定義で main_sandcastle.xslt ファイルを変更することにより、カスタム タグを作成できます。興味のあるファイルは次のとおりです。

変換/main_sandcastle.xslt コンテンツ/shared_content.xml

于 2012-09-12T17:10:20.780 に答える
0

ジェネリックを含む例が原因で、ドキュメントが正しく解析されず、すべての < を&lt;および >に置き換える必要がありました&gt;。

this is a test in the documentation example を入れてドキュメントをテストしましたが、うまくいきましたが、何らかの理由で実際のコードでは正しく動作しませんでした。タグを適切なエスケープ シーケンスに置き換えた後、すべてが正しく機能しました。

また、主張された {T} は、一般的なステートメントに変換されたのではなく、逐語的に印刷されたため、正しく機能しなかったことに注意してください。私は<code></code>ステートメントでこれを期待していますが、List<string>宣言も適切に機能することを期待しています。

于 2012-09-04T21:46:37.957 に答える