問題タブ [xml-comments]

私はいくつかの古いコードにアクセスしていますが、次のように、EventHandler <T>を使用するのではなく、デリゲートで手動で宣言されたイベントがかなりあります。

サンドキャッスルを使用してライブラリを文書化するまでは、イベント宣言によって生成されたプライベートの追加フィールドのXMLコメントが見つからないためです。私はそれを整理してみたいのですが、私がしたいのは次のいずれかです。

• すべてのプライベートフィールドを完全に無視するように指示せずに、自動生成されたプライベートフィールドを無視するようにサンドキャッスルを取得します

また

• プライベートフィールド用に生成されたXMLコメントを取得します

コードを次のようにリファクタリングせずにこれを実現する方法はありますか？

歴史的な理由から、同じコードで Doxygen と Visual Studio の両方のスタイルのコメントを使用する C# プロジェクトがあります。ある標準を別の標準に、できれば共通の XML サブセットに体系的に変換しようとした人はいますか?

最も一般的な機能をカバーするスクリプトを作成することはそれほど難しくないと思いますが、車輪の再発明はしたくありません。

この記事によると、複数行のXMLコメントを取得することが可能です-を使用する代わりに、を///使用して/** */ください。これは、複数行のコメントとは何か、そして私が何をしたいのかについての私の解釈です。

ただし、このフォームを使用すると、コード内のクラス名にカーソルを合わせるとポップアップするツールチップが1行になります。つまり、コメントを次のように記述した場合とまったく同じように見えます。

この動作はVS2008でも実際に可能ですか？

編集

gabeは、「マルチライン」の意味を誤解していると指摘しました。実際に使用する<para>か<br>、意図した効果を得る必要があります。<br>改行が発生する場所を制御したいので、先に進んで使用しました。

コードでこのクラスのツールチップを見ると、すべてが1行で終わっています... WTH？私はここで何か間違ったことをしましたか？

アップデート

<para>さて、私は先に進んで各行のタグを試しました、そしてそれはうまくいきます。なぜそうしないのかわから<br/>ない。

XMLコメントを使用することの長所を理解できません。コードの外部で優れたドキュメントに変換できることは知っていますが、はるかに簡潔なDOxygen構文でも同じことが実現できます。私の意見では、XMLコメントは間違っています。理由は次のとおりです。

1. 彼らは一般的にコメントとコードを難読化します。（人間が読むのはもっと難しいです）。
2. 「summary」と「/summary」は追加の行を使用するため、1つの画面で表示できるコードが少なくなります。
3. （削除）

では、その理由は何だったのでしょうか。単純なDOxygen構文ではなくXMLが.NETで好まれたのはなぜですか。

C# メソッドで XML コメントのリストを作成しようとしています。

次のドキュメントを使用していますが、このリストの実装はうまくいきません。Visual Studio 2008 と .net 3.5 を使用しています。

http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

C# で XML コメントを使用してリストを作成するにはどうすればよいですか?

これが私の現在の XML コードです。para タグは正常に機能しますが、リストは生成されません。

特定の XML ドキュメント (構造は変更できません) があり、ノードの上に書かれているコメントを取得したいと考えています。ドキュメントは次のようになります。

したがって、コメントはオプションですが、ある場合は、各属性の上にコメントを取得したいと考えています。を使用/*/comment()[n]するとコメント n が返されますが、n=2 の場合、当然 3 番目の属性のコメントが取得されるため、属性とコメントの間に関連はありません。何かアイデアはありますか? ありがとう

web.config次のようなコメントをファイルに入れたい：

サーバー側のコメントなどを使用して、このようにコメントを入れる方法はあります<% %>か?

私は、StyleCop で広範なルールセットを使用するチームで働いていますが、そのようなツールが役に立たなくなり、煩わしくなる一般的な点についてどう考えているのだろうかと思っています。また、GhostDoc を使用しているため、コードは XML コメントで埋め尽くされており、コードが読みにくく、レビューが困難になっています。私は XML コメントに問題はなく、場所によっては非常に便利だと思いますが、すべてのフィールドとプロパティで本当に必要なのでしょうか?

「各プロジェクトは、ビルド時に警告が 0 でなければならない」という立派な目標がありますが、この目標は妥当な StyleCop ルールセットに反するものでなければなりません。

これについてどう思いますか？

EDIT 私は今、実際にstylecop AT ALLのようなツールの議論は何なのか疑問に思っています? それを捨てて、賢明なコーディング標準と優れたコードレビューに残りを任せてみませんか? 特に有能なチームでは？確かに、すべての警告が関連するため、0 の警告を取得するタスクは実際に価値を追加します。

GhostDoc の唯一の利点は、XML コメントをゼロから作成するのに必要な数秒を節約できることだと思います。生成されたコメントを編集せずに受け入れる必要はないと思います-これはおそらく非生産的です。

これは、Stylecop ルール (SA1642: ConstructorSummaryDocumentationMustBeginWithStandardText) が GhostDoc によって生成された xml コメントによって満たされている組み合わせです - 一日の終わりに値を追加しますか?

私はWCFサービスを持っており、以下のように操作契約にコメントしています:

ただし、上記のように 3 つのスラッシュに入れている XML コメントは /// それを消費するクライアント アプリケーションのツールチップに表示されません。これは標準の WCF/Web サービス機能ですか? 彼らは決して現れませんか？またはそれらを表示させる方法はありますか？

タイトルが示すように、XML 自動コメント機能 (/// または ''') が機能しなくなりました。

ツール/オプション/環境でそれを見つけようとして30分を費やし、グーグルで検索し、再起動しましたが、まだ運がありません:-(

どこにあるかわかる方教えてください。