問題タブ [xml-documentation]

<see cref="switch" />、たとえば、機能しません-コンパイルの警告が表示されます：XML comment on ... has syntactically incorrect cref attribute 'switch'

興味のある人のためのコンテキスト...

問題のタグは の<remarks>タグにありSerializePropertyます。私は詳細なドキュメントの側で間違っています。また、いくつかの s を提供する予定<example>ですが、まだ手をつけていません。

XML Documentation Commentsを使用してアセンブリを文書化しています。そこからSandcastleを使用してchmファイルが作成されます。

私のアセンブリにはさまざまなインターフェイスが含まれており、それぞれが 1 つのクラスによって実装されています (私のシナリオでは、これらは WCF サービスです)。

インターフェイスにドキュメントを追加しました。実装クラスの関連メソッドを自動的にドキュメント化する方法はありますか?

以下の回答にあるこのクラスがあります。そこで、たとえばValuewith <see cref="Value"/>、およびクラス自体 with を参照できます<see cref="GenericEventArgs{T}"/>。

1. default(T) を参照するにはどうすればよいですか? それは可能ですか？
2. コンストラクターを参照するにはどうすればよいですか?

XMLコメントを使用して、クラスライブラリのすべてのタイプ、メソッド、プロパティなどを完全に文書化しようとしましたが、cref属性（seeたとえば、タグで使用される）に関連する奇妙な効果に遭遇しました。このMSDNページのアドバイスに加えて、MSDNや他のWebサイトの他のさまざまな例に従うと、crefタグを使用して参照値を指定するときは常に、参照を分類する特定のマーカー（'など）をプレフィックスとして付ける必要があるようです。タイプの場合はT：'、メソッドの場合は' M：'）。

ただし、Microsoft Sandcastleを使用すると、これらのプレフィックスを見逃すことにより、生成されたドキュメント（この場合はCHMヘルプファイル）に影響があることがわかりました。プレフィックスを含めると（私が信じるすべての状況で）、参照は太字のテキストとしてページにレンダリングされます...ただし、プレフィックスを除外すると、参照はAPIリファレンス内の適切なページへのアンカー（リンク）としてレンダリングされます。（すべて？）参照に接頭辞を付ける推奨される方法が最も役に立たない結果をもたらすことは私にはかなり奇妙に思えます-ある場合には参照を太字でレンダリングし、別の場合にはリンクする必要があるのはなぜですか？誰かがこれに光を当てることができれば幸いです。

名前空間のxml-docを作成しますか？はいの場合、どのように、どこで？

可能であれば、次のようなほとんど空のファイルだと思います。

しかし、それは機能しますか？あなたが...「宣言」するか、少なくとも他のすべてのファイルでも名前空間を使用するので...そして同じ名前空間のどこかにxml-documentationを書いたらどうなるでしょうか？1つはなくなったでしょうか？それとも、どういうわけかマージされますか？

コメントで動的ジェネリック クラス名を参照し、IDE で条件付きで解決できるかどうか疑問に思っていました。

簡単な基本クラスの例:

このクラスから継承し、たまたまUserクラスになった場合、IntelliSense にコメントを「データベースからすべての User メンバーを取得します」として表示させたいと思います。

これは可能ですか？

この質問は、Getting Emacs fill-paragraph to play nice with javadoc-like commentsに似ていますが、C# の場合です。

次のようなコメントがあります。

そして、 fill-paragraph がtext だけを塗りつぶし、マークアップ要素をそれぞれ別の行に保持したいと思います。

段落開始変数を設定する必要があると思います。Ch v によると、現在の値は次のとおりです。

...すでにかなり毛むくじゃらに見えます。(私は emacs 正規表現のすべてのエスケープ reqd が嫌いです。) XML doc 要素 (<remarks> など) の 後の最初の行が段落を開始すると言うには、後読みが必要だと思います。

私は今それをいじるつもりですが、インラインコードドキュメントを実行するように設定した人はいますか?

編集：おっと！Emacs 正規表現は後読みをしません! わかりました、他の提案はありますか？段落の開始を AFTER <summary> または <para> の行に設定するにはどうすればよいですか?

ps: 上記の私の例の偽のコード ドキュメントは、米国独立宣言のグーテンベルグ コピーに対するマルコフ連鎖操作から来ています。テクニックのこの質問に感謝します。

私のVisualStudioソリューションには、Webアプリケーションと単体テストアプリケーションが含まれています。私のWebアプリケーションはlog4netを使用しています。コマンドラインからmsbuildを使用してソリューションを構築できるようにしたいと考えています。ただし、コマンドラインからソリューションをビルドすると、log4net.xmlをテストプロジェクトのbinディレクトリにコピーできないため、ビルドエラーが発生します。

エラーメッセージは次のとおりです。

「ファイル'\bin\log4net.xml'を'bin\ Debug\log4net.xml'にコピーできません。パス'\bin\log4net.xml'へのアクセスが拒否されました。」

Visual Studioがこのファイルをロックしているように見えますが、なぜロックする必要があるのか​​わかりません。VSがロードしたプロジェクトのXMLドキュメントファイルをロックしないようにする方法はありますか？