xml-documentation

13熱

3答えて

奇妙な質問。私はMicrosoftのSandcastleを使用して、C＃コードのXMLコメントからドキュメントを生成しています。私のクラスのいくつかはすでにメソッドをコメントしているインターフェースを実装しています。私は、インタフェースメソッドとパブリック実装メソッドの両方でドキュメンテーションを複製するのではなく、このドキュメントをインターフェイスから「継承」するために使用できるタグがありますか

7熱

1答えて

リファレンスジェネリックコメント

コメント内でダイナミックジェネリッククラス名を参照し、IDEで条件付きで解決できるかどうかは疑問でしたか？シンプルなベースクラスの例： // <summary> // Retrieves all <T> members from the database. // </summary> public void GetAll<T>() { //magic } 私は今、このクラスから継

7熱

4答えて

XMLドキュメントインターフェイスの実装とクラスの実装

XML Documentation Commentsを使用してアセンブリを文書化しています。Sandcastleを使用してchmファイルが作成されます。私のアセンブリにはさまざまなインターフェイスが含まれています。それぞれのインターフェイスは1つのクラスで実装されています（私のシナリオではこれらはWCFサービスです）。私はインターフェイスにドキュメントを追加しました。実装するクラスの関連するメ

2熱

1答えて

.NET XMLドキュメントの参照接頭辞

XMLコメントを使用してクラスライブラリのすべての型、メソッド、プロパティなどを完全に文書化しようとしていますが、cref属性（seeタグ例えば）。 this MSDN pageのアドバイスと、MSDNや他のウェブサイトのさまざまな例を参考にして、crefタグを使って基準値を指定するときはいつも、それにrefresを分類する特定のマーカーを付ける必要があります： 'は型、' M： 'はメソッド）。

1熱

1答えて

メソッドコメントのXMLコメントを別のファイルに保存するにはどうすればよいですか？

この質問は Code documentation how much is too much? 一つの答えは別のファイルにしてXMLドキュメントを維持することでした。この問題に由来します。私はコードを見ているときのように答えが気に入っていましたが、ドキュメンテーションの冗長さは面倒です。一方、冗長性はintellisenseで正しいメソッドを検索したりドキュメントを公開したりするときに便利です。答

48熱

6答えて

ネームスペースのXMLドキュメント

ネームスペースにxml-docを記述しますか？そして、はいの場合、どのように、どこで？それは多分、このようなほとんど空のファイル頂ければ、と思うだろう： /// <summary> /// This namespace contains stuff /// </summary> namespace Some.Namespace { } れますが、その仕事？あなたは... "宣言"

2熱

2答えて

svcutilがC＃ファイルからドキュメントを取得するようにしますか？

フォーク、私は新しいWCFサービスを作成しており、私のサービスインターフェイスから始めました。さて、私もSomethingRequestとSomethingResponseメッセージを記述し、別のファイルにいくつかのデータコントラクトを作成し public interface ISomethingService { /// <summary> /// some

38熱

5答えて

C＃XMLドキュメントのジェネリック型の汎用型を参照してください。

述語ヘルパークラスのXMLドキュメントを記述しています。しかし、私はExpression<Func<T, bool>>を参照することができますが、構文エラーは出ません。それも可能ですか？私はこれを試してみました： <see cref="Expression{Func{T, bool}}"/> しかし、私は{T, bool}}下に赤い波線を取得します。これは機能します： <see cref="E

19熱

6答えて

C＃/ VisualStudio 2008でコードドキュメントをエクスポートするにはどうすればよいですか？

私はいつもクラスとメソッドの素晴らしいコードコメントをC＃xml構文で書いています。私はいつも後で簡単にそれらをエクスポートすることができると予想していました。今日私は実際にそうしなければなりませんが、どうやって見つけ出すのが難しいですか。私は行方不明のものがありますか？私はメニュー - >ビルド - >ビルドコードドキュメントに行きたいが、それを行うオプションはありません。

44熱

1答えて

XML文書でC＃キーワードをどのように参照するのですか？

<see cref="switch" />, たとえば、動作しません - 私はコンパイルの警告を取得します： XML comment on ... has syntactically incorrect cref attribute 'switch' 興味のある人のためのコンテキスト... /// <summary>Provides base functionality for hand-code